mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-21 20:13:05 +00:00
Default value tweaks (#2326)
This commit is contained in:
Chaz Larson
GitHub
parent
7deb0d6420
commit
840df4674b
134 changed files with 2760 additions and 1731 deletions
2
.github/.wordlist.txt
vendored
2
.github/.wordlist.txt
vendored
|
|
@ -50,6 +50,7 @@ chazlarson
|
||||||
codec
|
codec
|
||||||
codecs
|
codecs
|
||||||
collectionless
|
collectionless
|
||||||
|
CommonSense
|
||||||
config
|
config
|
||||||
configs
|
configs
|
||||||
cpp
|
cpp
|
||||||
|
|
@ -179,6 +180,7 @@ md
|
||||||
mdb
|
mdb
|
||||||
mdblist
|
mdblist
|
||||||
MDBList
|
MDBList
|
||||||
|
MDBLists
|
||||||
mediastinger
|
mediastinger
|
||||||
MediaStinger
|
MediaStinger
|
||||||
mediastingers
|
mediastingers
|
||||||
|
|
|
||||||
7
.markdownlint.yml
Normal file
7
.markdownlint.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
{
|
||||||
|
"MD009": false,
|
||||||
|
"MD013": false,
|
||||||
|
"MD033": false,
|
||||||
|
"MD045": false,
|
||||||
|
"MD046": false
|
||||||
|
}
|
||||||
|
|
@ -25,5 +25,6 @@ Fixes an issue where episode overlays sometimes wouldn't be added
|
||||||
Fixes an issue with IMDb Parental Labels not working
|
Fixes an issue with IMDb Parental Labels not working
|
||||||
Fixes an issue where OMDb returned `N/A` as the content rating
|
Fixes an issue where OMDb returned `N/A` as the content rating
|
||||||
Fixes an issue where `plex_collectionless` doesn't work if the item was added to a collection in the same run
|
Fixes an issue where `plex_collectionless` doesn't work if the item was added to a collection in the same run
|
||||||
|
Modifies default value presentation for default metadata files.
|
||||||
Fixes an issue causing IMDB collection to fail due to duplicate keys
|
Fixes an issue causing IMDB collection to fail due to duplicate keys
|
||||||
Removed Blog from the Navigation due to lack of time for updating/maintaining it
|
Removed Blog from the Navigation due to lack of time for updating/maintaining it
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ Arts Awards.
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:----------------------------------------------|:----------------------------------|:--------------------------------------------------------------------------------------------|
|
|:----------------------------------------------|:----------------------------------|:--------------------------------------------------------------------------------------------|
|
||||||
|
|
@ -48,16 +48,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `BAFTA <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `BAFTA <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> BAFTA Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> BAFTA Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `berlinale` Default Collection File is used to create collections based on t
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------------|:----------------------------------|:-----------------------------------------------------------------------------------|
|
|:------------------------------------------------------|:----------------------------------|:-----------------------------------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Berlinale <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Berlinale <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Berlinale Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Berlinale Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `cannes` Default Collection File is used to create collections based on the
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------|:----------------------------------|:------------------------------------------------------------|
|
|:------------------------------------------------|:----------------------------------|:------------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Cannes <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Cannes <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Cannes Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Cannes Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `cesar` Default Collection File is used to create collections based on the C
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:----------------------------------------------|:----------------------------------|:------------------------------------------------------|
|
|:----------------------------------------------|:----------------------------------|:------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `César <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `César <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> César Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> César Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `choice` Default Collection File is used to create collections based on the
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------------------------------------|:----------------------------------|:---------------------------------------------------------------|
|
|:------------------------------------------------------------------------------|:----------------------------------|:---------------------------------------------------------------|
|
||||||
|
|
@ -48,9 +48,9 @@ Note that the `template_variables:` section only needs to be used if you do want
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Critics Choice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Critics Choice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `emmy` Default Collection File is used to create collections based on the Em
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | |
|
| Collection | Key | |
|
||||||
|:----------------------------------------------|:----------------------------------|:------------------------------------------------------|
|
|:----------------------------------------------|:----------------------------------|:------------------------------------------------------|
|
||||||
|
|
@ -48,9 +48,9 @@ Note that the `template_variables:` section only needs to be used if you do want
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn off the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn off the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Emmys <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Emmys <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ Supported Library Types: Movie, Show
|
||||||
Recommendations: The `Golden Globe Best Motion Pictures` and `Golden Globes Best Director Winners` Collections only work
|
Recommendations: The `Golden Globe Best Motion Pictures` and `Golden Globes Best Director Winners` Collections only work
|
||||||
with Movie Libraries.
|
with Movie Libraries.
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------------------|:----------------------------------|:--------------------------------------------------------------|
|
|:------------------------------------------------------------|:----------------------------------|:--------------------------------------------------------------|
|
||||||
|
|
@ -54,16 +54,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Golden Globe <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Golden Globe <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Golden Globe Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Golden Globe Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `nfr` Default Collection File is used to create collections based on the Nat
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------------------------------------------------------------------|:----------------------------------|:----------------------------------------------------------------------------|
|
|:--------------------------------------------------------------------------------|:----------------------------------|:----------------------------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `National Film Registry <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `National Film Registry <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> National Film Registry.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> National Film Registry.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `oscars` Default Collection File is used to create collections based on the
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:----------------------------------------------------------------|:----------------------------------|:-------------------------------------------------------|
|
|:----------------------------------------------------------------|:----------------------------------|:-------------------------------------------------------|
|
||||||
|
|
@ -48,16 +48,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-6<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest-1<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-6<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest-1<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Oscars Winners <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Oscars Winners <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Academy Awards (Oscars) Winners for <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Academy Awards (Oscars) Winners for <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `pca` Default Collection File is used to create collections based on the Peo
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------------------------------------------------------------------|:----------------------------------|:----------------------------------------------------------------|
|
|:--------------------------------------------------------------------------------|:----------------------------------|:----------------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `People's Choice Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `People's Choice Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> People's Choice Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> People's Choice Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `razzie` Default Collection File is used to create collections based on the
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------|:----------------------------------|:-------------------------------------------------------|
|
|:------------------------------------------------|:----------------------------------|:-------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Razzie <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Razzie <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Razzie Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Razzie Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `sag` Default Collection File is used to create collections based on the Scr
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------------------------------------------------------------|:----------------------------------|:--------------------------------------------------------------------|
|
|:--------------------------------------------------------------------------|:----------------------------------|:--------------------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Screen Actors Guild <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Screen Actors Guild <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Screen Actors Guild Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Screen Actors Guild Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `separator_award` Default Collection File is used to create a separator coll
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------|:------------|:-------------------------------------------------------------------------------|
|
|:--------------------|:------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `spirit` Default Collection File is used to create collections based on the
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------------------------------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------|
|
|:--------------------------------------------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Independent Spirit Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Independent Spirit Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Independent Spirit Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Independent Spirit Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `sundance` Default Collection File is used to create collections based on t
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------------------------------------------------------------------|:----------------------------------|:-----------------------------------------------------------------------|
|
|:--------------------------------------------------------------------------------|:----------------------------------|:-----------------------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival 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:** `Sundance Film Festival of <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ Awards.
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:----------------------------------------------------------------------------------------------------------|:----------------------------------|:------------------------------------------------------------------------------------|
|
|:----------------------------------------------------------------------------------------------------------|:----------------------------------|:------------------------------------------------------------------------------------|
|
||||||
|
|
@ -48,16 +48,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Toronto International Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Toronto International Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Toronto International Film Festival Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Toronto International Film Festival Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `venice` Default Collection File is used to create collections based on the
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 130
|
## <a id="collection_section"></a>Collections Section 130
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------|:----------------------------------|:---------------------------------------------------------------------|
|
|:------------------------------------------------|:----------------------------------|:---------------------------------------------------------------------|
|
||||||
|
|
@ -47,16 +47,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Venice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Venice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Venice Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Venice Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ in your library.
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 140
|
## <a id="collection_section"></a>Collections Section 140
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------|:------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:------------------------------------------------|:------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -55,9 +55,9 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<br><strong>Default:</strong> 5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<br><strong>Default:</strong> 25<br><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<br><strong>Default:</strong> 5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<br><strong>Default:</strong> 25<br><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||||
| `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.<br>**Values:** List of Actor Names |
|
| `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.<br>**Values:** List of Actor Names |
|
||||||
| `exclude` | **Description:** Exclude these Actors from creating a Dynamic Collection.<br>**Values:** List of Actor Names |
|
| `exclude` | **Description:** Exclude these Actors from creating a Dynamic Collection.<br>**Values:** List of Actor Names |
|
||||||
|
|
@ -66,8 +66,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
||||||
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `aspect` Default Collection File is used to create collections with items th
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 125
|
## <a id="collection_section"></a>Collections Section 125
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-------------------------------|:------------|:-------------------------------------------------------------------------------|
|
|:-------------------------------|:------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -58,17 +58,17 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.<br>**Values:** List of Media Outlet Keys |
|
| `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.<br>**Values:** List of Media Outlet Keys |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<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 based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ available in your library.
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 090
|
## <a id="collection_section"></a>Collections Section 090
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------------|:-----------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:------------------------------------------------------|:-----------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -53,19 +53,19 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
| `include` | **Description:** Overrides the [default include list](#default-values)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||||
| `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
| `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||||
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).<br>**Values:** Dictionary with `key: new_key_name` entries |
|
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-values).<br>**Values:** Dictionary with `key: new_key_name` entries |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Audio`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Audio`<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 the <<key_name>> Language.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in the <<key_name>> Language.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -104,46 +104,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/audio_language.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="include:"
|
|
||||||
end="key_name_override:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default `key_name_override` (click to expand) <a class="headerlink" href="#key-name-override" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="key-name-override" />
|
|
||||||
|
|
||||||
```{ .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 ############
|
|
||||||
###############################################################################
|
|
||||||
key_name_override: {%
|
|
||||||
include-markdown "../../../defaults/both/audio_language.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="key_name_override:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ media outlets (such as Books or Video Games).
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 085
|
## <a id="collection_section"></a>Collections Section 085
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:---------------------------|:--------------|:-------------------------------------------------------------------------------|
|
|:---------------------------|:--------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -55,17 +55,17 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.<br>**Values:** List of Media Outlet Keys |
|
| `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.<br>**Values:** List of Media Outlet Keys |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<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 based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -69,7 +69,7 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image |
|
| `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image |
|
||||||
| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
|
| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
|
||||||
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#exclude-prefix)<br>**Values:** List of Prefixes | |
|
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#default-values). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#exclude-prefix)<br>**Values:** List of Prefixes | |
|
||||||
|
|
||||||
???+ example "Example Template Variable Amendments"
|
???+ example "Example Template Variable Amendments"
|
||||||
|
|
||||||
|
|
@ -92,28 +92,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `exclude_prefix` (click to expand) <a class="headerlink" href="#exclude-prefix" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<div id="exclude-prefix" />
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/both/collectionless.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check1"
|
|
||||||
end="# check2"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ Supported Library Types: Movie, Show
|
||||||
|
|
||||||
Recommendation: Set the Certification Country within your library's advanced settings to "Australia"
|
Recommendation: Set the Certification Country within your library's advanced settings to "Australia"
|
||||||
|
|
||||||
## Collections Section 110
|
## <a id="collection_section"></a>Collections Section 110
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-------------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------------|
|
|:-------------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------------|
|
||||||
|
|
@ -58,21 +58,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 Content Ratings found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings 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 Content Ratings found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Content Ratings found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -114,46 +114,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/content_rating_au.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/both/content_rating_au.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ Recommendations: Use the
|
||||||
[Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either
|
[Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either
|
||||||
`mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
|
`mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
|
||||||
|
|
||||||
## Collections Section 110
|
## <a id="collection_section"></a>Collections Section 110
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------------------------|:---------------------------------|:--------------------------------------------------------------------------------------|
|
|:------------------------------------------------------------------|:---------------------------------|:--------------------------------------------------------------------------------------|
|
||||||
|
|
@ -60,21 +60,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 Content Ratings found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings 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 Content Ratings found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Content Ratings found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Age <<key_name>>+ <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Age <<key_name>>+ <<library_translationU>>s`<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 that are rated <<key_name>> accorfing to the Common Sense Rating System.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>> accorfing to the Common Sense Rating System.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -116,46 +116,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/content_rating_cs.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/both/content_rating_cs.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ Supported Library Types: Movie, Show
|
||||||
|
|
||||||
Recommendation: Set the Certification Country within your library's advanced settings to "Germany"
|
Recommendation: Set the Certification Country within your library's advanced settings to "Germany"
|
||||||
|
|
||||||
## Collections Section 110
|
## <a id="collection_section"></a>Collections Section 110
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:----------------------------------------------------------------|:--------------------------------------------|:--------------------------------------------------------------------------------------|
|
|:----------------------------------------------------------------|:--------------------------------------------|:--------------------------------------------------------------------------------------|
|
||||||
|
|
@ -58,21 +58,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 Content Ratings found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings 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 Content Ratings found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Content Ratings found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -114,46 +114,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/content_rating_de.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/both/content_rating_de.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ Recommendations: Use the
|
||||||
[Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with `mal` to
|
[Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with `mal` to
|
||||||
update Plex to the MyAnimeList Content Rating.
|
update Plex to the MyAnimeList Content Rating.
|
||||||
|
|
||||||
## Collections Section 110
|
## <a id="collection_section"></a>Collections Section 110
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:----------------------------------------------------------------|:---------------------------------------------|:-------------------------------------------------------------------------------|
|
|:----------------------------------------------------------------|:---------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -66,21 +66,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 Content Ratings found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings 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 Content Ratings found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Content Ratings found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -123,46 +123,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/content_rating_mal.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/both/content_rating_mal.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ Supported Library Types: Movie, Show
|
||||||
|
|
||||||
Recommendation: Set the Certification Country within your library's advanced settings to "New Zealand"
|
Recommendation: Set the Certification Country within your library's advanced settings to "New Zealand"
|
||||||
|
|
||||||
## Collections Section 110
|
## <a id="collection_section"></a>Collections Section 110
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-------------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------------|
|
|:-------------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------------|
|
||||||
|
|
@ -58,21 +58,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 Content Ratings found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings 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 Content Ratings found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Content Ratings found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -114,46 +114,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/content_rating_nz.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/both/content_rating_nz.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ Supported Library Types: Movie, Show
|
||||||
|
|
||||||
Recommendation: Set the Certification Country within your library's advanced settings to "United Kingdom"
|
Recommendation: Set the Certification Country within your library's advanced settings to "United Kingdom"
|
||||||
|
|
||||||
## Collections Section 110
|
## <a id="collection_section"></a>Collections Section 110
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------------------------------------------------|:------------------------------------------|:--------------------------------------------------------------------------------------|
|
|:--------------------------------------------------------------|:------------------------------------------|:--------------------------------------------------------------------------------------|
|
||||||
|
|
@ -58,21 +58,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 Content Ratings found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings 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 Content Ratings found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Content Ratings found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -114,46 +114,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/content_rating_uk.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/both/content_rating_uk.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ This file also merges similarly named genres (such as "Sci-Fi", "SciFi" and "Sci
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 060
|
## <a id="collection_section"></a>Collections Section 060
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:---------------------------------------------------------|:-------------------------------------|:-------------------------------------------------------------------------------|
|
|:---------------------------------------------------------|:-------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -53,18 +53,18 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.<br>**Values:** List of Genres found in your library |
|
| `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.<br>**Values:** List of Genres 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 Genres found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Genres found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Genres found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Genres found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Genres found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Genres found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the genre <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the genre <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -110,26 +110,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `addons` (click to expand) <a class="headerlink" href="#addons" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/genre.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ your library.
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 120
|
## <a id="collection_section"></a>Collections Section 120
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-------------------------------------------------------------|:------------------------------------|:-------------------------------------------------------------------------------|
|
|:-------------------------------------------------------------|:------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -63,21 +63,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `style` | **Description:** Controls the visual theme of the collections created.<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>default</code></td><td>Default Theme</td></tr><tr><td><code>standards</code></td><td>Standards Theme</td></tr></table> |
|
| `style` | **Description:** Controls the visual theme of the collections created.<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>default</code></td><td>Default Theme</td></tr><tr><td><code>standards</code></td><td>Standards Theme</td></tr></table> |
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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:** Any Resolutions found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** Any Resolutions found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Resolutions found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Resolutions found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Resolutions found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Resolutions found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.<br>**Values:** List of Resolutions found in your library |
|
| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.<br>**Values:** List of Resolutions 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 Resolutions found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Resolutions found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Resolutions found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Resolutions found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Resolutions found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Resolutions found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -114,40 +114,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<div id="include" />
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
include: {%
|
|
||||||
include-markdown "../../../defaults/both/resolution.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/both/resolution.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ your media is available on.
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 030
|
## <a id="collection_section"></a>Collections Section 030
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:---------------------------|:--------------|:-------------------------------------------------------------------------------|
|
|:---------------------------|:--------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -80,11 +80,11 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.<br>**Default:** `us`<br>**Values:** Any [ISO 3166-1 Code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) of the region where the streaming information should be based on. |
|
| `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.<br>**Default:** `us`<br>**Values:** Any [ISO 3166-1 Code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) of the region where the streaming information should be based on. |
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `500`<br>**Values:** Number Greater than 0 |
|
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `500`<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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.<br>**Values:** List of Streaming Service Keys |
|
| `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.<br>**Values:** List of Streaming Service Keys |
|
||||||
| `originals_only` | **Description:** Changes Streaming Service lists to only show original content produced by the service.<br>**Note**: Cannot be used with `region`, and only produces collections for `amazon`, `appletv`, `disney`, `max`, `hulu`, `netflix`, `paramount`, `peacock`<br>**Default:** `false`<br>**Values:** `true`, `false` |
|
| `originals_only` | **Description:** Changes Streaming Service lists to only show original content produced by the service.<br>**Note**: Cannot be used with `region`, and only produces collections for `amazon`, `appletv`, `disney`, `max`, `hulu`, `netflix`, `paramount`, `peacock`<br>**Default:** `false`<br>**Values:** `true`, `false` |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
|
|
@ -92,8 +92,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `discover_with_<<key>>` | **Description:** Overrides the TMDb Watch Provider used for the specfied key. This is only needed if a specific `region` has a different ID for the watch provider.<br>**Default:** `<<discover_with>>`<br>**Values:** Any TMDb Watch Provider ID for [Movies](https://developer.themoviedb.org/reference/watch-providers-movie-list) / [Shows](https://developer.themoviedb.org/reference/watch-provider-tv-list) based on the user's region |
|
| `discover_with_<<key>>` | **Description:** Overrides the TMDb Watch Provider used for the specfied key. This is only needed if a specific `region` has a different ID for the watch provider.<br>**Default:** `<<discover_with>>`<br>**Values:** Any TMDb Watch Provider ID for [Movies](https://developer.themoviedb.org/reference/watch-providers-movie-list) / [Shows](https://developer.themoviedb.org/reference/watch-provider-tv-list) based on the user's region |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ Century Studios")
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 070
|
## <a id="collection_section"></a>Collections Section 070
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-----------------------------------------------------|:-----------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:-----------------------------------------------------|:-----------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -55,21 +55,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 Studios found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of Studios found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Studios found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Studios found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Studios found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Studios found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Studios from creating a Dynamic Collection.<br>**Values:** List of Studios found in your library |
|
| `exclude` | **Description:** Exclude these Studios from creating a Dynamic Collection.<br>**Values:** List of Studios 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 Studios found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Studios found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Studios found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Studios found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Studios found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Studios found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -108,46 +108,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/studio.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/both/studio.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ languages available in your library.
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 095
|
## <a id="collection_section"></a>Collections Section 095
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:---------------------------------------------------------|:------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:---------------------------------------------------------|:------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -53,19 +53,19 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
| `include` | **Description:** Overrides the [default include list](#default-values)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||||
| `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
| `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||||
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).<br>**Values:** Dictionary with `key: new_key_name` entries |
|
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-values).<br>**Values:** Dictionary with `key: new_key_name` entries |
|
||||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Subtitles`<br>**Values:** Any string with `<<key_name>>` in it. |
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Subtitles`<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 with <<key_name>> Subtitles.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s with <<key_name>> Subtitles.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -104,46 +104,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/both/subtitle_language.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="include:"
|
|
||||||
end="key_name_override:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default `key_name_override` (click to expand) <a class="headerlink" href="#key-name-override" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="key-name-override" />
|
|
||||||
|
|
||||||
```{ .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 ############
|
|
||||||
###############################################################################
|
|
||||||
key_name_override: {%
|
|
||||||
include-markdown "../../../defaults/both/subtitle_language.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="key_name_override:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ Marvel Cinematic Universe or Wizarding World).
|
||||||
|
|
||||||
Supported Library Types: Movie & Show
|
Supported Library Types: Movie & Show
|
||||||
|
|
||||||
## Collections Section 040
|
## <a id="collection_section"></a>Collections Section 040
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-----------------------------|:------------|:-------------------------------------------------------------------------------|
|
|:-----------------------------|:------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -66,21 +66,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |
|
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |
|
||||||
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the specified key's collection. <br>**Values:** Any String |
|
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the [key's](#collection_section) collection. <br>**Values:** Any String |
|
||||||
| `imdb_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the IMDb List to the specified key's collection.<br>**Values:** List of IMDb List URLs | | |
|
| `imdb_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the IMDb List to the [key's](#collection_section) collection.<br>**Values:** List of IMDb List URLs | | |
|
||||||
| `mdblist_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the MDBList List to the specified key's collection. Overrides the [default mdblist_url](#mdblist-url) for that collection if used.<br>**Values:** List of MDBList List URLs | | | |
|
| `mdblist_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the MDBList List to the [key's](#collection_section) collection. Overrides the [default mdblist_url](#default-values) for that collection if used.<br>**Values:** List of MDBList List URLs | | | |
|
||||||
| `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the specified key's collection. Overrides the [default trakt_url](#trakt-url) for that collection if used.<br>**Values:** List of Trakt List URLs | | | |
|
| `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the [key's](#collection_section) collection. Overrides the [default trakt_url](#default-values) for that collection if used.<br>**Values:** List of Trakt List URLs | | | |
|
||||||
| `data` | **Description:** Overrides the [default data dictionary](#data). Defines the data that the custom dynamic collection processes.<br>**Values:** Dictionary List of keys/names |
|
| `data` | **Description:** Overrides the [default data dictionary](#default-values). Defines the data that the custom dynamic collection processes.<br>**Values:** Dictionary List of keys/names |
|
||||||
| `append_data` | **Description:** Appends to the [default data dictionary](#data).<br>**Values:** Dictionary List of keys/names |
|
| `append_data` | **Description:** Appends to the [default data dictionary](#default-values).<br>**Values:** Dictionary List of keys/names |
|
||||||
| `remove_data` | **Description:** Removes from the [default data dictionary](#data).<br>**Values:** List of keys to remove |
|
| `remove_data` | **Description:** Removes from the [default data dictionary](#default-values).<br>**Values:** List of keys to remove |
|
||||||
| `exclude` | **Description:** Exclude these Universes from creating a Dynamic Collection.<br>**Values:** List of Universes |
|
| `exclude` | **Description:** Exclude these Universes from creating a Dynamic Collection.<br>**Values:** List of Universes |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -122,69 +122,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `data` (click to expand) <a class="headerlink" href="#data" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<div id="data" />
|
|
||||||
|
|
||||||
```{ .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 ############
|
|
||||||
###############################################################################
|
|
||||||
data: {%
|
|
||||||
include-markdown "../../../defaults/both/universe.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="data:"
|
|
||||||
end="template:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable`trakt_url` (click to expand) <a class="headerlink" href="#trakt-url" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="trakt-url" />
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/both/universe.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check1"
|
|
||||||
end="# check2"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable`mdblist_url` (click to expand) <a class="headerlink" href="#mdblist-url" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="mdblist-url" />
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/both/universe.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check2"
|
|
||||||
end="# check3"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ library, sorted by critic rating to create a "best of <year>"
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 105
|
## <a id="collection_section"></a>Collections Section 105
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------------------|
|
|:--------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -52,14 +52,14 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `10`<br>**Values:** Number Greater than 0 |
|
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `10`<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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> current_year-10<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> current_year<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> current_year-10<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> current_year<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
|
||||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `anilist` Default Collection File is used to create collections based on Ani
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 020
|
## <a id="collection_section"></a>Collections Section 020
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------|:-----------|:-----------------------------------------------------|
|
|:--------------------|:-----------|:-----------------------------------------------------|
|
||||||
|
|
@ -50,15 +50,15 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number greater than 0 |
|
| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number greater than 0 |
|
||||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the number of items in a collection of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number greater than 0 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the number of items in a collection of the [key's](#collection_section) collection.<br>**Default:** `limit`<br>**Values:** Number greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `basic` Default Collection File is used to create collections based on recen
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 010
|
## <a id="collection_section"></a>Collections Section 010
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-----------------|:-----------|:---------------------------------------------------------------|
|
|:-----------------|:-----------|:---------------------------------------------------------------|
|
||||||
|
|
@ -48,14 +48,14 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.<br>**Values:** Number greater than 0 |
|
| `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.<br>**Values:** Number greater than 0 |
|
||||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number greater than 0 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `in_the_last_<<key>>`<sup>1</sup> | **Description:** Changes how far back the Smart Filter looks.<table class="clearTable"><tr><td>**Default:**</td></tr><tr><td>`released`</td><td>`90`</td></tr><tr><td>`episodes`</td><td>`7`</td></tr></table>**Values:** Number greater than 0 |
|
| `in_the_last_<<key>>`<sup>1</sup> | **Description:** Changes how far back the Smart Filter looks.<table class="clearTable"><tr><td>**Default:**</td></tr><tr><td>`released`</td><td>`90`</td></tr><tr><td>`episodes`</td><td>`7`</td></tr></table>**Values:** Number greater than 0 |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ Supported Library Types: Movie, Show
|
||||||
|
|
||||||
Recommendations: The `IMDb Lowest Rated` Collection only works with Movie Libraries
|
Recommendations: The `IMDb Lowest Rated` Collection only works with Movie Libraries
|
||||||
|
|
||||||
## Collections Section 020
|
## <a id="collection_section"></a>Collections Section 020
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------|:----------|:-----------------------------------------------------|
|
|:--------------------|:----------|:-----------------------------------------------------|
|
||||||
|
|
@ -51,13 +51,13 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ Recommendations: Users might consider increasing the value set for the template
|
||||||
|
|
||||||
The collections `IMDb Top 250 (Letterboxd)`, `Oscar Best Picture Winners`, and `Cannes Palme d'Or Winners` are turned off by default as these collections already exist within other defaults. Refer to the examples below for turning the collections on within the Letterboxd defaults using template variables.
|
The collections `IMDb Top 250 (Letterboxd)`, `Oscar Best Picture Winners`, and `Cannes Palme d'Or Winners` are turned off by default as these collections already exist within other defaults. Refer to the examples below for turning the collections on within the Letterboxd defaults using template variables.
|
||||||
|
|
||||||
## Collections Section 020
|
## <a id="collection_section"></a>Collections Section 020
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:---------------------------------|:--------------------|:------------------------------------------------------------------------------|
|
|:---------------------------------|:--------------------|:------------------------------------------------------------------------------|
|
||||||
|
|
@ -63,15 +63,15 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `cache_builders` | **Description:** Changes the Builder Cache for all collections in a Defaults file.<br>**Default:** `1`<br>**Values:** number 0 or greater |
|
| `cache_builders` | **Description:** Changes the Builder Cache for all collections in a Defaults file.<br>**Default:** `1`<br>**Values:** number 0 or greater |
|
||||||
| `cache_builders_<<key>>` | **Description:** Changes the Builder Cache of the specified key's collection.<br>**Default:** `1`<br>**Values:** number 0 or greater |
|
| `cache_builders_<<key>>` | **Description:** Changes the Builder Cache of the [key's](#collection_section) collection.<br>**Default:** `1`<br>**Values:** number 0 or greater |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `myanimelist` Default Collection File is used to create collections based on
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 020
|
## <a id="collection_section"></a>Collections Section 020
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-------------------------|:------------|:--------------------------------------------------------|
|
|:-------------------------|:------------|:--------------------------------------------------------|
|
||||||
|
|
@ -51,16 +51,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| 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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.<br>**Default:** `limit`<br>**Values:** Number greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `starting_only` | **Description:** Changes the season collection to only use anime listed under the new section on [MAL Seasons](https://myanimelist.net/anime/season/)<br>**Default:** `False`<br>**Values:** `True` or `False` |
|
| `starting_only` | **Description:** Changes the season collection to only use anime listed under the new section on [MAL Seasons](https://myanimelist.net/anime/season/)<br>**Default:** `False`<br>**Values:** `True` or `False` |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ Supported Library Types: Movie, Show
|
||||||
|
|
||||||
Recommendations: The `StevenLu's Popular Movies` and `Top 10 Pirated Movies of the Week` Collections only work with Movie Libraries
|
Recommendations: The `StevenLu's Popular Movies` and `Top 10 Pirated Movies of the Week` Collections only work with Movie Libraries
|
||||||
|
|
||||||
## Collections Section 020
|
## <a id="collection_section"></a>Collections Section 020
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------|:--------------|:-----------------------------------------------------|
|
|:------------------------------------|:--------------|:-----------------------------------------------------|
|
||||||
|
|
@ -53,13 +53,13 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.<br>**Default:** `30`<br>**Values:** Number greater than 0 |
|
| `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.<br>**Default:** `30`<br>**Values:** Number greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `separator_chart` Default Collection File is used to create a separator coll
|
||||||
|
|
||||||
Supported Library Types: Movie, Show
|
Supported Library Types: Movie, Show
|
||||||
|
|
||||||
## Collections Section 020
|
## <a id="collection_section"></a>Collections Section 020
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------|:------------|:-------------------------------------------------------------------------------|
|
|:--------------------|:------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ Supported Library Types: Movie, Show
|
||||||
|
|
||||||
Requirements: [Tautulli Authentication](../../config/tautulli.md)
|
Requirements: [Tautulli Authentication](../../config/tautulli.md)
|
||||||
|
|
||||||
## Collections Section 020
|
## <a id="collection_section"></a>Collections Section 020
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:---------------|:----------|:-----------------------------------------------------|
|
|:---------------|:----------|:-----------------------------------------------------|
|
||||||
|
|
@ -51,13 +51,13 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `list_days` | **Description:** Changes the `list_days` attribute of the builder for all collections in a Defaults file.<br>**Values:** Number greater than 0 |
|
| `list_days` | **Description:** Changes the `list_days` attribute of the builder for all collections in a Defaults file.<br>**Values:** Number greater than 0 |
|
||||||
| `list_days_<<key>>`<sup>1</sup> | **Description:** Changes the `list_days` attribute of the builder of the specified key's collection.<br>**Values:** Number greater than 0 |
|
| `list_days_<<key>>`<sup>1</sup> | **Description:** Changes the `list_days` attribute of the builder of the [key's](#collection_section) collection.<br>**Values:** Number greater than 0 |
|
||||||
| `list_size` | **Description:** Changes the `list_size` attribute of the builder for all collections in a Defaults file.<br>**Values:** Number greater than 0 |
|
| `list_size` | **Description:** Changes the `list_size` attribute of the builder for all collections in a Defaults file.<br>**Values:** Number greater than 0 |
|
||||||
| `list_size_<<key>>`<sup>1</sup> | **Description:** Changes the `list_size` attribute of the builder of the specified key's collection.<br>**Values:** Number greater than 0 |
|
| `list_size_<<key>>`<sup>1</sup> | **Description:** Changes the `list_size` attribute of the builder of the [key's](#collection_section) collection.<br>**Values:** Number greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ Supported Library Types: Movie, Show
|
||||||
|
|
||||||
Recommendations: The `TMDb Airing Today` and `TMDb On The Air` Collections only work with Show Libraries
|
Recommendations: The `TMDb Airing Today` and `TMDb On The Air` Collections only work with Show Libraries
|
||||||
|
|
||||||
## Collections Section 020
|
## <a id="collection_section"></a>Collections Section 020
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------|:-----------|:-----------------------------------------------------|
|
|:--------------------|:-----------|:-----------------------------------------------------|
|
||||||
|
|
@ -53,15 +53,15 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| 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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.<br>**Default:** `limit`<br>**Values:** Number greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ Supported Library Types: Movie, Show
|
||||||
|
|
||||||
Requirements: [Trakt Authentication](../../config/trakt.md)
|
Requirements: [Trakt Authentication](../../config/trakt.md)
|
||||||
|
|
||||||
## Collections Section 020
|
## <a id="collection_section"></a>Collections Section 020
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------|:--------------|:-----------------------------------------------------------|
|
|:--------------------|:--------------|:-----------------------------------------------------------|
|
||||||
|
|
@ -54,11 +54,11 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| 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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@ File paths need to be valid in the context where Kometa is running; this is prim
|
||||||
| `language` | **Description:** Set the language of Collection Names and Summaries<br>**Default:** `default`<br>**Values:** `default` (English), `fr` (French), or `de` (German) |
|
| `language` | **Description:** Set the language of Collection Names and Summaries<br>**Default:** `default`<br>**Values:** `default` (English), `fr` (French), or `de` (German) |
|
||||||
| `use_all` | **Description:** Turns off all Collections in a Defaults file.<br>**Values:** `false` to turn off the collection |
|
| `use_all` | **Description:** Turns off all Collections in a Defaults file.<br>**Values:** `false` to turn off the collection |
|
||||||
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Collections in a Defaults file.<br>**Values:** `false` to turn off the collection |
|
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Collections in a Defaults file.<br>**Values:** `false` to turn off the collection |
|
||||||
| `name_<<key>>`<sup>1</sup> | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name |
|
| `name_<<key>>`<sup>1</sup> | **Description:** Changes the name of the key's collection.<br>**Values:** New Collection Name |
|
||||||
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
|
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the key's collection.<br>**Values:** New Collection Summary |
|
||||||
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||||
| `sort_prefix` | **Description:** Changes the prefix of the sort title.<br>**Default:** `!`<br>**Values:** Any String |
|
| `sort_prefix` | **Description:** Changes the prefix of the sort title.<br>**Default:** `!`<br>**Values:** Any String |
|
||||||
| `sort_title` | **Description:** Changes the sort title of all collections.<br>**Default:** `<<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>>`<br>**Values:** Any String |
|
| `sort_title` | **Description:** Changes the sort title of all collections.<br>**Default:** `<<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>>`<br>**Values:** Any String |
|
||||||
|
|
@ -16,52 +16,52 @@ File paths need to be valid in the context where Kometa is running; this is prim
|
||||||
| `ignore_ids` | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs |
|
| `ignore_ids` | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs |
|
||||||
| `ignore_imdb_ids` | **Description:** Set a list or comma-separated string of IMDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of IMDb IDs |
|
| `ignore_imdb_ids` | **Description:** Set a list or comma-separated string of IMDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of IMDb IDs |
|
||||||
| `minimum_items` | **Description:** Set the number of minimum items for a collection to be created for all collections.<br>**Values:** Any number greater than 0 |
|
| `minimum_items` | **Description:** Set the number of minimum items for a collection to be created for all collections.<br>**Values:** Any number greater than 0 |
|
||||||
| `minimum_items_<<key>>`<sup>1</sup> | **Description:** Set the number of minimum items for a collection to be created for the specified key's collection.<br>**Values:** Any number greater than 0 |
|
| `minimum_items_<<key>>`<sup>1</sup> | **Description:** Set the number of minimum items for a collection to be created for the key's collection.<br>**Values:** Any number greater than 0 |
|
||||||
| `schedule` | **Description:** Set the schedule for all of the collections in a Defaults file.<br>**Values:** Any [Scheduling Option](../config/schedule.md#important) |
|
| `schedule` | **Description:** Set the schedule for all of the collections in a Defaults file.<br>**Values:** Any [Scheduling Option](../config/schedule.md#important) |
|
||||||
| `schedule_<<key>>` | **Description:** Set the schedule for a specific key's collection.<br>**Values:** Any [Scheduling Option](../config/schedule.md#important) |
|
| `schedule_<<key>>` | **Description:** Set the schedule for a specific key's collection.<br>**Values:** Any [Scheduling Option](../config/schedule.md#important) |
|
||||||
| `delete_collections_named` | **Description:** Used to delete any collections in your plex named one of the given collections.<br>**Values:** List of Collection Names to delete |
|
| `delete_collections_named` | **Description:** Used to delete any collections in your plex named one of the given collections.<br>**Values:** List of Collection Names to delete |
|
||||||
| `url_poster` | **Description:** Changes the poster url for all collections.<br>**Values:** URL directly to the Image |
|
| `url_poster` | **Description:** Changes the poster url for all collections.<br>**Values:** URL directly to the Image |
|
||||||
| `url_poster_<<key>>`<sup>1</sup> | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image |
|
| `url_poster_<<key>>`<sup>1</sup> | **Description:** Changes the poster url of the key's collection.<br>**Values:** URL directly to the Image |
|
||||||
| `file_poster` | **Description:** Sets the poster filepath for all collections.<br>**Values:** Filepath directly to the Image |
|
| `file_poster` | **Description:** Sets the poster filepath for all collections.<br>**Values:** Filepath directly to the Image |
|
||||||
| `file_poster_<<key>>`<sup>1</sup> | **Description:** Sets the poster filepath of the specified key's collection.<br>**Values:** Filepath directly to the Image |
|
| `file_poster_<<key>>`<sup>1</sup> | **Description:** Sets the poster filepath of the key's collection.<br>**Values:** Filepath directly to the Image |
|
||||||
| `url_background` | **Description:** Sets the background url for all collections.<br>**Values:** URL directly to the Image |
|
| `url_background` | **Description:** Sets the background url for all collections.<br>**Values:** URL directly to the Image |
|
||||||
| `url_background_<<key>>`<sup>1</sup> | **Description:** Sets the background url of the specified key's collection.<br>**Values:** URL directly to the Image |
|
| `url_background_<<key>>`<sup>1</sup> | **Description:** Sets the background url of the key's collection.<br>**Values:** URL directly to the Image |
|
||||||
| `file_background` | **Description:** Sets the background filepath for all collections.<br>**Values:** Filepath directly to the Image |
|
| `file_background` | **Description:** Sets the background filepath for all collections.<br>**Values:** Filepath directly to the Image |
|
||||||
| `file_background_<<key>>`<sup>1</sup> | **Description:** Sets the background filepath of the specified key's collection.<br>**Values:** Filepath directly to the Image |
|
| `file_background_<<key>>`<sup>1</sup> | **Description:** Sets the background filepath of the key's collection.<br>**Values:** Filepath directly to the Image |
|
||||||
| `visible_library` | **Description:** Controls visible on Library Recommended Tab for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
| `visible_library` | **Description:** Controls visible on Library Recommended Tab for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
||||||
| `visible_library_<<key>>`<sup>1</sup> | **Description:** Controls visible on Library Recommended Tab of the specified key's collection. (Only works with Plex Pass)<br>**Default:** `visible_library`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
| `visible_library_<<key>>`<sup>1</sup> | **Description:** Controls visible on Library Recommended Tab of the key's collection. (Only works with Plex Pass)<br>**Default:** `visible_library`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
||||||
| `visible_home` | **Description:** Controls visible on Home Tab for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
| `visible_home` | **Description:** Controls visible on Home Tab for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
||||||
| `visible_home_<<key>>`<sup>1</sup> | **Description:** Controls visible on Home Tab of the specified key's collection. (Only works with Plex Pass)<br>**Default:** `visible_home`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
| `visible_home_<<key>>`<sup>1</sup> | **Description:** Controls visible on Home Tab of the key's collection. (Only works with Plex Pass)<br>**Default:** `visible_home`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
||||||
| `visible_shared` | **Description:** Controls visible on Shared Users' Home Tab for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
| `visible_shared` | **Description:** Controls visible on Shared Users' Home Tab for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
||||||
| `visible_shared_<<key>>`<sup>1</sup> | **Description:** Controls visible on Shared Users' Home Tab of the specified key's collection. (Only works with Plex Pass)<br>**Default:** `visible_shared`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
| `visible_shared_<<key>>`<sup>1</sup> | **Description:** Controls visible on Shared Users' Home Tab of the key's collection. (Only works with Plex Pass)<br>**Default:** `visible_shared`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../config/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
|
||||||
| `radarr_upgrade_existing` | **Description:** Override Radarr `upgrade_existing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `radarr_upgrade_existing` | **Description:** Override Radarr `upgrade_existing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `radarr_upgrade_existing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `upgrade_existing` attribute of the specified key's collection.<br>**Values:** `true` or `false` |
|
| `radarr_upgrade_existing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `upgrade_existing` attribute of the key's collection.<br>**Values:** `true` or `false` |
|
||||||
| `radarr_monitor_existing` | **Description:** Override Radarr `monitor_existing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `radarr_monitor_existing` | **Description:** Override Radarr `monitor_existing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `radarr_monitor_existing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `monitor_existing` attribute of the specified key's collection.<br>**Values:** `true` or `false` |
|
| `radarr_monitor_existing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `monitor_existing` attribute of the key's collection.<br>**Values:** `true` or `false` |
|
||||||
| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `radarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `add_missing` attribute of the specified key's collection.<br>**Default:** `radarr_add_missing`<br>**Values:** `true` or `false` |
|
| `radarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `add_missing` attribute of the key's collection.<br>**Default:** `radarr_add_missing`<br>**Values:** `true` or `false` |
|
||||||
| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
||||||
| `radarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Radarr `root_folder_path` attribute of the specified key's collection.<br>**Default:** `radarr_folder`<br>**Values:** Folder Path |
|
| `radarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Radarr `root_folder_path` attribute of the key's collection.<br>**Default:** `radarr_folder`<br>**Values:** Folder Path |
|
||||||
| `radarr_search` | **Description:** Override Radarr `search` attribute or all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `radarr_search` | **Description:** Override Radarr `search` attribute or all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `radarr_search_<<key>>`<sup>1</sup> | **Description:** Override Radarr `search` attribute of the specified key's collection.<br>**Default:** `radarr_search`<br>**Values:** `true` or `false` |
|
| `radarr_search_<<key>>`<sup>1</sup> | **Description:** Override Radarr `search` attribute of the key's collection.<br>**Default:** `radarr_search`<br>**Values:** `true` or `false` |
|
||||||
| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `radarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Radarr `tag` attribute of the specified key's collection.<br>**Default:** `radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `radarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Radarr `tag` attribute of the key's collection.<br>**Default:** `radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_radarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.<br>**Default:** `item_radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `item_radarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the key's collection.<br>**Default:** `item_radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
| `sonarr_upgrade_existing` | **Description:** Override Sonarr `upgrade_existing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `sonarr_upgrade_existing` | **Description:** Override Sonarr `upgrade_existing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_upgrade_existing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `upgrade_existing` attribute of the specified key's collection.<br>**Values:** `true` or `false` |
|
| `sonarr_upgrade_existing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `upgrade_existing` attribute of the key's collection.<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_monitor_existing` | **Description:** Override Sonarr `monitor_existing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `sonarr_monitor_existing` | **Description:** Override Sonarr `monitor_existing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_monitor_existing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `monitor_existing` attribute of the specified key's collection.<br>**Values:** `true` or `false` |
|
| `sonarr_monitor_existing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `monitor_existing` attribute of the key's collection.<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the specified key's collection.<br>**Default:** `sonarr_add_missing`<br>**Values:** `true` or `false` |
|
| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the key's collection.<br>**Default:** `sonarr_add_missing`<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
||||||
| `sonarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's collection.<br>**Default:** `sonarr_folder`<br>**Values:** Folder Path |
|
| `sonarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `root_folder_path` attribute of the key's collection.<br>**Default:** `sonarr_folder`<br>**Values:** Folder Path |
|
||||||
| `sonarr_search` | **Description:** Override Sonarr `search` attribute or all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `sonarr_search` | **Description:** Override Sonarr `search` attribute or all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_search_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `search` attribute of the specified key's collection.<br>**Default:** `sonarr_search`<br>**Values:** `true` or `false` |
|
| `sonarr_search_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `search` attribute of the key's collection.<br>**Default:** `sonarr_search`<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `tag` attribute of the specified key's collection.<br>**Default:** `sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `tag` attribute of the key's collection.<br>**Default:** `sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's collection.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the key's collection.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with
|
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with
|
||||||
when calling.
|
when calling.
|
||||||
|
|
@ -16,7 +16,7 @@ Supported Library Types: Movie
|
||||||
|
|
||||||
Recommendation: Set the Certification Country within your library's advanced settings to "United States".
|
Recommendation: Set the Certification Country within your library's advanced settings to "United States".
|
||||||
|
|
||||||
## Collections Section 110
|
## <a id="collection_section"></a>Collections Section 110
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------|
|
|:-------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------|
|
||||||
|
|
@ -57,21 +57,21 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 Content Ratings found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings 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 Content Ratings found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Content Ratings found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -113,46 +113,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/content_rating_us.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/content_rating_us.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ library. The collection aims to be inclusive, with all 230 countries incorporate
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 082
|
## <a id="collection_section"></a>Collections Section 082
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------|:------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:------------------------------------------------|:------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -59,22 +59,22 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `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> |
|
| `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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** 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 |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<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 |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<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 |
|
| `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 |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Countries found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<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 |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<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 |
|
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-values).<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. |
|
| `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. |
|
| `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
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -115,46 +115,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/continent.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/continent.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ library.
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 080
|
## <a id="collection_section"></a>Collections Section 080
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:----------------------------------------|:----------------------------------------|:-------------------------------------------------------------------------------|
|
|:----------------------------------------|:----------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -59,22 +59,22 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `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> |
|
| `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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** 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 |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<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 |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<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 |
|
| `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 |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Countries found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<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 |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<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 |
|
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-values).<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. |
|
| `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. |
|
| `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
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -115,46 +115,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/country.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/country.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ library, sorted by critic rating to create a "best of <decade>"
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 100
|
## <a id="collection_section"></a>Collections Section 100
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-----------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------------------|
|
|:-----------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -51,15 +51,15 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| 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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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](../../files/builders/smart.md#sort-options) |
|
| `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](../../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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.<br>**Values:** List of Decades found in your library |
|
| `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. |
|
| `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. |
|
| `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. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ your library.
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 150
|
## <a id="collection_section"></a>Collections Section 150
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:---------------------------------------------------|:---------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:---------------------------------------------------|:---------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -52,9 +52,9 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<br><strong>Default:</strong> 5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<br><strong>Default:</strong> 25<br><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<br><strong>Default:</strong> 5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<br><strong>Default:</strong> 25<br><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||||
| `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.<br>**Values:** List of Actor Names |
|
| `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.<br>**Values:** List of Actor Names |
|
||||||
| `exclude` | **Description:** Exclude these Directors from creating a Dynamic Collection.<br>**Values:** List of Director Names |
|
| `exclude` | **Description:** Exclude these Directors from creating a Dynamic Collection.<br>**Values:** List of Director Names |
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@ your library.
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections
|
## <a id="collection_section"></a>Collections
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-------------------------------------------------|:--------------------------------------------------|:-------------------------------------------------------|
|
|:-------------------------------------------------|:--------------------------------------------------|:-------------------------------------------------------|
|
||||||
|
|
@ -52,36 +52,36 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
|
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the [key's](#collection_section) collection.<br>**Values:** New Collection Summary |
|
||||||
| `collection_section` | **Description:** Adds a sort title with this collection sections.<br>**Values:** Any number |
|
| `collection_section` | **Description:** Adds a sort title with this collection sections.<br>**Values:** Any number |
|
||||||
| `order_<<key>>`<sup>1</sup> | **Description:** Controls the sort order of the collections in their collection section.<br>**Values:** Any number |
|
| `order_<<key>>`<sup>1</sup> | **Description:** Controls the sort order of the collections in their collection section.<br>**Values:** Any number |
|
||||||
| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
||||||
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |
|
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |
|
||||||
| `movie_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#movie) for that collection if used.<br>**Values:** List of TMDb Movie IDs |
|
| `movie_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Movie IDs given to the [key's](#collection_section) collection. Overrides the [default movie](#default-values) for that collection if used.<br>**Values:** List of TMDb Movie IDs |
|
||||||
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#name-mapping) for that collection if used.<br>**Values:** Any String |
|
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the [key's](#collection_section) collection.Overrides the [default name_mapping](#default-values) for that collection if used.<br>**Values:** Any String |
|
||||||
| `sort_title` | **Description:** Sets the sort title for all collections. Use `<<collection_name>>` to use the collection name. **Example:** `"!02_<<collection_name>>"`<br>**Values:** Any String with `<<collection_name>>` |
|
| `sort_title` | **Description:** Sets the sort title for all collections. Use `<<collection_name>>` to use the collection name. **Example:** `"!02_<<collection_name>>"`<br>**Values:** Any String with `<<collection_name>>` |
|
||||||
| `sort_title_<<key>>`<sup>1</sup> | **Description:** Sets the sort title of the specified key's collection.<br>**Default:** `sort_title`<br>**Values:** Any String |
|
| `sort_title_<<key>>`<sup>1</sup> | **Description:** Sets the sort title of the [key's](#collection_section) collection.<br>**Default:** `sort_title`<br>**Values:** Any String |
|
||||||
| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.<br>**Values:** `false` to not build the collection |
|
| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.<br>**Values:** `false` to not build the collection |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `title_override` | **Description:** Overrides the [default title_override dictionary](#title-override).<br>**Values:** Dictionary with `key: new_title` entries |
|
| `title_override` | **Description:** Overrides the [default title_override dictionary](#default-values).<br>**Values:** Dictionary with `key: new_title` entries |
|
||||||
| `exclude` | **Description:** Exclude these TMDb Collections from creating a Dynamic Collection.<br>**Values:** List of TMDb Collection IDs |
|
| `exclude` | **Description:** Exclude these TMDb Collections from creating a Dynamic Collection.<br>**Values:** List of TMDb Collection IDs |
|
||||||
| `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 TMDb Collection IDs |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 TMDb Collection IDs |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of TMDb Collection IDs |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of TMDb Collection IDs |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of TMDb Collection IDs |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of TMDb Collection IDs |
|
||||||
| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `radarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `add_missing` attribute of the specified key's collection.<br>**Default:** `radarr_add_missing`<br>**Values:** `true` or `false` |
|
| `radarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `add_missing` attribute of the [key's](#collection_section) collection.<br>**Default:** `radarr_add_missing`<br>**Values:** `true` or `false` |
|
||||||
| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
||||||
| `radarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Radarr `root_folder_path` attribute of the specified key's collection.<br>**Default:** `radarr_folder`<br>**Values:** Folder Path |
|
| `radarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Radarr `root_folder_path` attribute of the [key's](#collection_section) collection.<br>**Default:** `radarr_folder`<br>**Values:** Folder Path |
|
||||||
| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `radarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Radarr `tag` attribute of the specified key's collection.<br>**Default:** `radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `radarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Radarr `tag` attribute of the [key's](#collection_section) collection.<br>**Default:** `radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_radarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.<br>**Default:** `item_radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `item_radarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the [key's](#collection_section) collection.<br>**Default:** `item_radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
???+ example "Example Template Variable Amendments"
|
???+ example "Example Template Variable Amendments"
|
||||||
|
|
||||||
|
|
@ -109,96 +109,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `addons` (click to expand) <a class="headerlink" href="#addons" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/franchise.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
end="title_override:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default `title_override` (click to expand) <a class="headerlink" href="#title-override" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="title-override" />
|
|
||||||
|
|
||||||
```{ .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 ############
|
|
||||||
###############################################################################
|
|
||||||
title_override: {%
|
|
||||||
include-markdown "../../../defaults/movie/franchise.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="title_override:"
|
|
||||||
end="template_variables:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable `movie` (click to expand) <a class="headerlink" href="#movie" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="movie" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `movie_<<key>>` to the file as template variables to change this value per collection.
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/movie/franchise.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check1"
|
|
||||||
end="# check2"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable `name_mapping` (click to expand) <a class="headerlink" href="#name-mapping" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="name-mapping" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `name_mapping_<<key>>` to the file as template variables to change this value per collection.
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/movie/franchise.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check2"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ your library.
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 160
|
## <a id="collection_section"></a>Collections Section 160
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:---------------------------------------------------|:---------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:---------------------------------------------------|:---------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -52,9 +52,9 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<br><strong>Default:</strong> 5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<br><strong>Default:</strong> 25<br><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<br><strong>Default:</strong> 5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<br><strong>Default:</strong> 25<br><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||||
| `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.<br>**Values:** List of Actor Names |
|
| `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.<br>**Values:** List of Actor Names |
|
||||||
| `exclude` | **Description:** Exclude these Producers from creating a Dynamic Collection.<br>**Values:** List of Producer Names |
|
| `exclude` | **Description:** Exclude these Producers from creating a Dynamic Collection.<br>**Values:** List of Producer Names |
|
||||||
|
|
@ -63,8 +63,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
||||||
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@ might be seen as controversial. You are welcome to edit this to fit your own aud
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 081
|
## <a id="collection_section"></a>Collections Section 081
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------------------------|:--------------------------------------|:-------------------------------------------------------------------------------|
|
|:--------------------------------------|:--------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -63,22 +63,22 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `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> |
|
| `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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<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 |
|
| `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 |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<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 |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<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 |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<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 |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<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 |
|
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-values).<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. |
|
| `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. |
|
| `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
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -119,46 +119,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ The `seasonal` Default Collection File is used to dynamically create seasonal co
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 000
|
## <a id="collection_section"></a>Collections Section 000
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:----------------------------------------------|:----------------|:-------------------------------------------------------------------------------|
|
|:----------------------------------------------|:----------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -65,32 +65,32 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:--------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:--------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `tmdb_collection_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Collection IDs given to the specified key's collection. Overrides the [default tmdb_collection](#tmdb-collection) for that collection if used.<br>**Values:** List of TMDb Collection IDs |
|
| `tmdb_collection_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Collection IDs given to the specified [key's](#collection_section) collection. Overrides the [default tmdb_collection](#default-values) for that collection if used.<br>**Values:** List of TMDb Collection IDs |
|
||||||
| `tmdb_movie_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default tmdb_movie](#tmdb-movie) for that collection if used.<br>**Values:** List of TMDb Movie IDs |
|
| `tmdb_movie_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Movie IDs given to the specified [key's](#collection_section) collection. Overrides the [default tmdb_movie](#default-values) for that collection if used.<br>**Values:** List of TMDb Movie IDs |
|
||||||
| `imdb_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the IMDb List to the specified key's collection.<br>**Values:** List of IMDb List URLs |
|
| `imdb_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the IMDb List to the specified [key's](#collection_section) collection.<br>**Values:** List of IMDb List URLs |
|
||||||
| `imdb_search_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the IMDb Search to the specified key's collection. Overrides the [default imdb_search](#imdb-search) for that collection if used.<br>**Values:** List of IMDb List URLs |
|
| `imdb_search_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the IMDb Search to the specified [key's](#collection_section) collection. Overrides the [default imdb_search](#default-values) for that collection if used.<br>**Values:** List of IMDb List URLs |
|
||||||
| `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the specified key's collection. Overrides the [default trakt_list](#trakt-list) for that collection if used.<br>**Values:** List of Trakt List URLs |
|
| `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the specified [key's](#collection_section) collection. Overrides the [default trakt_list](#default-values) for that collection if used.<br>**Values:** List of Trakt List URLs |
|
||||||
| `mdblist_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the MDb List to the specified key's collection. Overrides the [default mdblist_list](#mdblist-list) for that collection if used.<br>**Values:** List of MDBList URLs |
|
| `mdblist_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the MDb List to the specified [key's](#collection_section) collection. Overrides the [default mdblist_list](#default-values) for that collection if used.<br>**Values:** List of MDBList URLs |
|
||||||
| `letterboxd_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Letterboxd List to the specified key's collection.<br>**Values:** List of Letterboxd List URLs |
|
| `letterboxd_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Letterboxd List to the specified [key's](#collection_section) collection.<br>**Values:** List of Letterboxd List URLs |
|
||||||
| `emoji` | **Description:** Controls the Emoji Prefix for all Collections. Set to `""` to remove all emojis.<br>**Values:** Any String |
|
| `emoji` | **Description:** Controls the Emoji Prefix for all Collections. Set to `""` to remove all emojis.<br>**Values:** Any String |
|
||||||
| `emoji_<<key>>`<sup>1</sup> | **Description:** Controls the Emoji Prefix for the specified key's collection. Overrides the [default emoji](#emoji) for that collection if used.<br>**Values:** Any String |
|
| `emoji_<<key>>`<sup>1</sup> | **Description:** Controls the Emoji Prefix for the specified [key's](#collection_section) collection. Overrides the [default emoji](#default-values) for that collection if used.<br>**Values:** Any String |
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in this file.<br>**Values:** Number Greater than 0 |
|
| `limit` | **Description:** Changes the Builder Limit for all collections in this 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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified [key's](#collection_section) collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in this file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in this 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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `schedule` | **Description:** Changes the Schedule for all collections in this file. Use `daily` to have all collections show.<br>**Values:** [Any Schedule Option](../../config/schedule.md) |
|
| `schedule` | **Description:** Changes the Schedule for all collections in this file. Use `daily` to have all collections show.<br>**Values:** [Any Schedule Option](../../config/schedule.md) |
|
||||||
| `schedule_<<key>>`<sup>1</sup> | **Description:** Changes the Schedule of the specified key's collection. Overrides the [default schedule](#schedule) for that collection if used.<br>**Values:** [Any Schedule Option](../../config/schedule.md) |
|
| `schedule_<<key>>`<sup>1</sup> | **Description:** Changes the Schedule of the specified [key's](#collection_section) collection. Overrides the [default schedule](#default-values) for that collection if used.<br>**Values:** [Any Schedule Option](../../config/schedule.md) |
|
||||||
| `data` | **Description:** Overrides the [default data dictionary](#data). Defines the data that the custom dynamic collection processes.<br>**Values:** Dictionary List of keys/names |
|
| `data` | **Description:** Overrides the [default data dictionary](#default-values). Defines the data that the custom dynamic collection processes.<br>**Values:** Dictionary List of keys/names |
|
||||||
| `append_data` | **Description:** Appends to the [default data dictionary](#data).<br>**Values:** Dictionary List of keys/names |
|
| `append_data` | **Description:** Appends to the [default data dictionary](#default-values).<br>**Values:** Dictionary List of keys/names |
|
||||||
| `remove_data` | **Description:** Removes from the [default data dictionary](#data).<br>**Values:** List of keys to remove |
|
| `remove_data` | **Description:** Removes from the [default data dictionary](#default-values).<br>**Values:** List of keys to remove |
|
||||||
| `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.<br>**Values:** List of Seasons Keys |
|
| `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.<br>**Values:** List of Seasons Keys |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **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. |
|
| `summary_format` | **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. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
@ -119,220 +119,49 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
use_independence: false #(1)!
|
use_independence: false #(1)!
|
||||||
schedule_thanksgiving: range(10/01-10/30) #(2)!
|
schedule_thanksgiving: range(10/01-10/30) #(2)!
|
||||||
sort_by: random #(3)!
|
sort_by: random #(3)!
|
||||||
|
tmdb_collection_years: #(4)!
|
||||||
|
- 1234
|
||||||
|
- 5678
|
||||||
|
tmdb_movie_valentine: #(5)!
|
||||||
|
- 4321
|
||||||
|
- 8765
|
||||||
|
imdb_list_patrick: https://www.imdb.com/list/ls089196478/ #(6)!
|
||||||
|
imdb_search_easter: #(7)!
|
||||||
|
list.any:
|
||||||
|
- ls075298827
|
||||||
|
- ls000099714
|
||||||
|
trakt_list_mother: #(8)!
|
||||||
|
- https://trakt.tv/users/robertsnorlax/lists/arizona-westerns
|
||||||
|
- https://trakt.tv/users/pullsa/lists/the-96th-academy-awards-oscars-2024
|
||||||
|
mdblist_list_memorial: https://mdblist.com/lists/rizreflects/world-war-related-movies #(9)!
|
||||||
|
letterboxd_list_father: https://letterboxd.com/patrickb15/list/fathers-day/ #(10)!
|
||||||
append_data:
|
append_data:
|
||||||
apes: Planet of the Apes Day #(4)!
|
apes: Planet of the Apes Day #(11)!
|
||||||
schedule_apes: range(11/24-11/26) #(5)!
|
schedule_apes: range(11/24-11/26) #(12)!
|
||||||
imdb_list_apes: https://www.imdb.com/list/ls005126084/ #(6)!
|
imdb_list_apes: https://www.imdb.com/list/ls005126084/ #(13)!
|
||||||
emoji_apes: "🐵 " #(7)!
|
emoji_apes: "🐵 " #(14)!
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Do not create the "Independence Day" collection
|
1. Do not create the "Independence Day" collection
|
||||||
2. Set a custom schedule for the Thanksgiving Day collection
|
2. Set a custom schedule for the Thanksgiving Day collection
|
||||||
3. Sort the collections created by this file in random order
|
3. Sort the collections created by this file in random order
|
||||||
4. Create a new Seasonal collection called "Planet of the Apes Day", and set the key for this collection to `apes`
|
4. Add two TMDB collections to the "New Year's Day" collection
|
||||||
5. Set a scheduled range for the "Planet of the Apes Day" collection. Planet Of The Apes Day is 11/25.
|
5. Add two movies to the "Valentine's Day" collection
|
||||||
6. Add an IMDb List to be used for the "Planet of the Apes Day" collection
|
6. Replace the IMDb List for the "St. Patrick's Day" collection
|
||||||
7. Add the 🐵 emoji to the "Planet of the Apes Day" collection so that the title in Plex is "🐵 Planet of the Apes
|
7. Add the contents of two IMDB lists to the "Easter" collection
|
||||||
|
8. Replace the lists for the "Mother's Day" collection with two Trakt lists
|
||||||
|
9. Replace the source list for the "Memorial Day" collection with a MDBList
|
||||||
|
10. Replace the source list for the "Father's Day" collection with a Letterboxd list
|
||||||
|
11. Create a new Seasonal collection called "Planet of the Apes Day", and set the key for this collection to `apes`
|
||||||
|
12. Set a scheduled range for the "Planet of the Apes Day" collection. Planet Of The Apes Day is 11/25.
|
||||||
|
13. Add an IMDb List to be used for the "Planet of the Apes Day" collection
|
||||||
|
14. Add the 🐵 emoji to the "Planet of the Apes Day" collection so that the title in Plex is "🐵 Planet of the Apes
|
||||||
Day Movies"
|
Day Movies"
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `data` (click to expand) <a class="headerlink" href="#data" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<div id="data" />
|
|
||||||
|
|
||||||
```{ .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 ############
|
|
||||||
###############################################################################
|
|
||||||
data: {%
|
|
||||||
include-markdown "../../../defaults/movie/seasonal.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="data:"
|
|
||||||
end="title_format:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable `emoji` (click to expand) <a class="headerlink" href="#emoji" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="emoji" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `emoji_<<key>>` to the file as template variables to change this value per collection.
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/movie/seasonal.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check1"
|
|
||||||
end="# check2"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable `schedule` (click to expand) <a class="headerlink" href="#schedule" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="schedule" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `schedule_<<key>>` to the file as template variables to change this value per collection.
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/movie/seasonal.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check2"
|
|
||||||
end="# check4"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable `imdb_search` (click to expand) <a class="headerlink" href="#imdb-search" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="imdb-search" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `imdb_search_<<key>>` to the file as template variables to change this value per collection.
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/movie/seasonal.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check4"
|
|
||||||
end="# check5"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable `tmdb_collection` (click to expand) <a class="headerlink" href="#tmdb-collection" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="tmdb-collection" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `tmdb_collection_<<key>>` to the file as template variables to change this value per collection.
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/movie/seasonal.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check5"
|
|
||||||
end="# check6"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable `tmdb_movie` (click to expand) <a class="headerlink" href="#tmdb-movie" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="tmdb-movie" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `tmdb_movie_<<key>>` to the file as template variables to change this value per collection.
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/movie/seasonal.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check6"
|
|
||||||
end="# check7"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable `mdblist_list` (click to expand) <a class="headerlink" href="#mdblist-list" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="mdblist-list" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `mdblist_list_<<key>>` to the file as template variables to change this value per collection.
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/movie/seasonal.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check7"
|
|
||||||
end="# check8"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Default Template Variable `trakt_list` (click to expand) <a class="headerlink" href="#trakt-list" title="Permanent link">¶</a>"
|
|
||||||
|
|
||||||
<div id="trakt-list" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `trakt_list_<<key>>` to the file as template variables to change this value per collection.
|
|
||||||
|
|
||||||
```{ .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-markdown "../../../defaults/movie/seasonal.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="# check8"
|
|
||||||
end="# check9"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ library.
|
||||||
|
|
||||||
Supported Library Types: Movie
|
Supported Library Types: Movie
|
||||||
|
|
||||||
## Collections Section 170
|
## <a id="collection_section"></a>Collections Section 170
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-------------------------------------------------|:-------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:-------------------------------------------------|:-------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -52,9 +52,9 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<br><strong>Default:</strong> 5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<br><strong>Default:</strong> 25<br><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<br><strong>Default:</strong> 5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<br><strong>Default:</strong> 25<br><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||||
| `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.<br>**Values:** List of Actor Names |
|
| `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.<br>**Values:** List of Actor Names |
|
||||||
| `exclude` | **Description:** Exclude these Writers from creating a Dynamic Collection.<br>**Values:** List of Writer Names |
|
| `exclude` | **Description:** Exclude these Writers from creating a Dynamic Collection.<br>**Values:** List of Writer Names |
|
||||||
|
|
@ -63,8 +63,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
||||||
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -55,35 +55,35 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Playlists in a Defaults file.<br>**Values:** `false` to turn off the playlist |
|
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Playlists in a Defaults file.<br>**Values:** `false` to turn off the playlist |
|
||||||
| `name_<<key>>`<sup>1</sup> | **Description:** Changes the name of the specified key's playlist.<br>**Values:** New Playlist Name |
|
| `name_<<key>>`<sup>1</sup> | **Description:** Changes the name of the key's playlist.<br>**Values:** New Playlist Name |
|
||||||
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the specified key's playlist.<br>**Values:** New Playlist Summary |
|
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the key's playlist.<br>**Values:** New Playlist Summary |
|
||||||
| `libraries` | **Description:** Sets the names of the libraries to use for the Playlists.<br>**Default:** `Movies, TV Shows`<br>**Values:** Comma-separated string or list of library mapping names defined in the `libraries` attribute in the base of your [Configuration File](../config/overview.md. |
|
| `libraries` | **Description:** Sets the names of the libraries to use for the Playlists.<br>**Default:** `Movies, TV Shows`<br>**Values:** Comma-separated string or list of library mapping names defined in the `libraries` attribute in the base of your [Configuration File](../config/overview.md. |
|
||||||
| `sync_to_users` | **Description:** Sets the users to sync all playlists to.<br>**Default:** `playlist_sync_to_users` Global Setting Value<br>**Values:** Comma-separated string or list of user names. |
|
| `sync_to_users` | **Description:** Sets the users to sync all playlists to.<br>**Default:** `playlist_sync_to_users` Global Setting Value<br>**Values:** Comma-separated string or list of user names. |
|
||||||
| `sync_to_users_<<key>>`<sup>1</sup> | **Description:** Sets the users to sync the specified key's playlist to.<br>**Default:** `sync_to_user` Value<br>**Values:** Comma-separated string or list of user names. |
|
| `sync_to_users_<<key>>`<sup>1</sup> | **Description:** Sets the users to sync the key's playlist to.<br>**Default:** `sync_to_user` Value<br>**Values:** Comma-separated string or list of user names. |
|
||||||
| `exclude_user` | **Description:** Sets the users to exclude from sync for all playlists.<br>**Default:** `playlist_sync_to_users` Global Setting Value<br>**Values:** Comma-separated string or list of user names. |
|
| `exclude_user` | **Description:** Sets the users to exclude from sync for all playlists.<br>**Default:** `playlist_sync_to_users` Global Setting Value<br>**Values:** Comma-separated string or list of user names. |
|
||||||
| `exclude_user_<<key>>`<sup>1</sup> | **Description:** Sets the users to exclude from sync the specified key's playlist.<br>**Default:** `sync_to_users` Value<br>**Values:** Comma-separated string or list of user names. |
|
| `exclude_user_<<key>>`<sup>1</sup> | **Description:** Sets the users to exclude from sync the key's playlist.<br>**Default:** `sync_to_users` Value<br>**Values:** Comma-separated string or list of user names. |
|
||||||
| `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the specified key's playlist. Overrides the [default trakt_list] for that playlist if used.<br>**Values:** List of Trakt List URLs | | | |
|
| `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the key's playlist. Overrides the [default trakt_list] for that playlist if used.<br>**Values:** List of Trakt List URLs | | | |
|
||||||
| `delete_playlist` | **Description:** Will delete all playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` |
|
| `delete_playlist` | **Description:** Will delete all playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` |
|
||||||
| `delete_playlist_<<key>>`<sup>1</sup> | **Description:** Will delete the specified key's playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` |
|
| `delete_playlist_<<key>>`<sup>1</sup> | **Description:** Will delete the key's playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` |
|
||||||
| `ignore_ids` | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all playlists.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs |
|
| `ignore_ids` | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all playlists.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs |
|
||||||
| `ignore_imdb_ids` | **Description:** Set a list or comma-separated string of IMDb IDs to ignore in all playlists.<br>**Values:** List or comma-separated string of IMDb IDs |
|
| `ignore_imdb_ids` | **Description:** Set a list or comma-separated string of IMDb IDs to ignore in all playlists.<br>**Values:** List or comma-separated string of IMDb IDs |
|
||||||
| `url_poster_<<key>>`<sup>1</sup> | **Description:** Changes the poster url of the specified key's playlist.<br>**Values:** URL directly to the Image |
|
| `url_poster_<<key>>`<sup>1</sup> | **Description:** Changes the poster url of the key's playlist.<br>**Values:** URL directly to the Image |
|
||||||
| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all playlists in a Defaults file.<br>**Values:** `true` or `false` |
|
| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all playlists in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `radarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `add_missing` attribute of the specified key's playlist.<br>**Default:** `radarr_add_missing`<br>**Values:** `true` or `false` |
|
| `radarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `add_missing` attribute of the key's playlist.<br>**Default:** `radarr_add_missing`<br>**Values:** `true` or `false` |
|
||||||
| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all playlists in a Defaults file.<br>**Values:** Folder Path |
|
| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all playlists in a Defaults file.<br>**Values:** Folder Path |
|
||||||
| `radarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Radarr `root_folder_path` attribute of the specified key's playlist.<br>**Default:** `radarr_folder`<br>**Values:** Folder Path |
|
| `radarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Radarr `root_folder_path` attribute of the key's playlist.<br>**Default:** `radarr_folder`<br>**Values:** Folder Path |
|
||||||
| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all playlists in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all playlists in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `radarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Radarr `tag` attribute of the specified key's playlist.<br>**Default:** `radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `radarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Radarr `tag` attribute of the key's playlist.<br>**Default:** `radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all playlists in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all playlists in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_radarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's playlist.<br>**Default:** `item_radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `item_radarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the key's playlist.<br>**Default:** `item_radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all playlists in a Defaults file.<br>**Values:** `true` or `false` |
|
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all playlists in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the specified key's playlist.<br>**Default:** `sonarr_add_missing`<br>**Values:** `true` or `false` |
|
| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the key's playlist.<br>**Default:** `sonarr_add_missing`<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all playlists in a Defaults file.<br>**Values:** Folder Path |
|
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all playlists in a Defaults file.<br>**Values:** Folder Path |
|
||||||
| `sonarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's playlist.<br>**Default:** `sonarr_folder`<br>**Values:** Folder Path |
|
| `sonarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `root_folder_path` attribute of the key's playlist.<br>**Default:** `sonarr_folder`<br>**Values:** Folder Path |
|
||||||
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all playlists in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all playlists in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `tag` attribute of the specified key's playlist.<br>**Default:** `sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `tag` attribute of the key's playlist.<br>**Default:** `sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all playlists in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all playlists in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's playlist.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the key's playlist.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||||
|
|
||||||
|
|
@ -104,26 +104,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default Template Variable `trakt_list` (click to expand) <a class="headerlink" href="#trakt-list" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](sources.md).
|
||||||
|
|
||||||
<div id="trakt-list" />
|
|
||||||
|
|
||||||
???+ tip
|
|
||||||
|
|
||||||
Pass `trakt_list_<<key>>` to the file as template variables to change this value per playlist.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
{%
|
|
||||||
include-markdown "../../defaults/playlist.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=true
|
|
||||||
dedent=true
|
|
||||||
start="conditions:"
|
|
||||||
end="default:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -8,8 +8,8 @@
|
||||||
| `placeholder_tmdb_movie` | **Description:** Add a placeholder Movie to the Separator. Only valid for Movie libraries.<br>**Values:** TMDb Movie ID |
|
| `placeholder_tmdb_movie` | **Description:** Add a placeholder Movie to the Separator. Only valid for Movie libraries.<br>**Values:** TMDb Movie ID |
|
||||||
| `placeholder_tvdb_show` | **Description:** Add a placeholder Show to the Separator. Only valid for Show libraries.<br>**Values:** TVDb Show ID |
|
| `placeholder_tvdb_show` | **Description:** Add a placeholder Show to the Separator. Only valid for Show libraries.<br>**Values:** TVDb Show ID |
|
||||||
| `placeholder_imdb_id` | **Description:** Add a placeholder Movie/Show to the Separator. Valid for Movie or Show libraries assuming the ID points to an item of the correct type.<br>**Values:** IMDb ID |
|
| `placeholder_imdb_id` | **Description:** Add a placeholder Movie/Show to the Separator. Valid for Movie or Show libraries assuming the ID points to an item of the correct type.<br>**Values:** IMDb ID |
|
||||||
| `name_separator` | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name |
|
| `name_separator` | **Description:** Changes the name of the key's collection.<br>**Values:** New Collection Name |
|
||||||
| `summary_separator` | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
|
| `summary_separator` | **Description:** Changes the summary of the key's collection.<br>**Values:** New Collection Summary |
|
||||||
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number |
|
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number |
|
||||||
| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
||||||
| `url_poster_separator` | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image |
|
| `url_poster_separator` | **Description:** Changes the poster url of the key's collection.<br>**Values:** URL directly to the Image |
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ the respective rating system.
|
||||||
|
|
||||||
Supported Library Types: Show
|
Supported Library Types: Show
|
||||||
|
|
||||||
## Collections Section 110
|
## <a id="collection_section"></a>Collections Section 110
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:---------------------------------------------------------|:---------------------------------------------|:-------------------------------------------------------------------------------|
|
|:---------------------------------------------------------|:---------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -55,16 +55,16 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 Content Ratings found in your library |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Content Ratings found in your library |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of Content Ratings found in your library |
|
||||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings 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 Content Ratings found in your library |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 Content Ratings found in your library |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||||
| `name_format` | **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. |
|
| `name_format` | **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. |
|
||||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
|
|
@ -111,46 +111,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/show/content_rating_us.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/show/content_rating_us.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ The `continent` Default Collection File is used to dynamically create collection
|
||||||
|
|
||||||
Supported Library Types: Show
|
Supported Library Types: Show
|
||||||
|
|
||||||
## Collections Section 082
|
## <a id="collection_section"></a>Collections Section 082
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------|:---------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:------------------------------------------------|:---------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -55,19 +55,19 @@ Note that the `template_variables:` section only needs to be used if you do want
|
||||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `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> |
|
| `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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `addons` | **Description:** 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `addons` | **Description:** 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).<br>**Values:** Dictionary with `key: new_key_name` entries |
|
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-values).<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. |
|
| `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. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
|
|
@ -106,45 +106,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
||||||
|
|
||||||
## Default Values
|
## 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.**
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/show/continent.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/show/continent.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ The `country` Default Collection File is used to dynamically create collections
|
||||||
|
|
||||||
Supported Library Types: Show
|
Supported Library Types: Show
|
||||||
|
|
||||||
## Collections Section 080
|
## <a id="collection_section"></a>Collections Section 080
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:----------------------------------------|:---------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:----------------------------------------|:---------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -55,19 +55,19 @@ Note that the `template_variables:` section only needs to be used if you do want
|
||||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `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> |
|
| `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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `addons` | **Description:** 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `addons` | **Description:** 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).<br>**Values:** Dictionary with `key: new_key_name` entries |
|
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-values).<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. |
|
| `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. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
|
|
@ -106,45 +106,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
||||||
|
|
||||||
## Default Values
|
## 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.**
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/show/country.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/show/country.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ sorted by critic rating to create a "best of <decade>"
|
||||||
|
|
||||||
Supported Library Types: Show
|
Supported Library Types: Show
|
||||||
|
|
||||||
## Collections Section 100
|
## <a id="collection_section"></a>Collections Section 100
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:-----------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------------------|
|
|:-----------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -51,15 +51,15 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| 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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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](../../files/builders/smart.md#sort-options) |
|
| `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](../../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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||||
| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.<br>**Values:** List of Decades found in your library |
|
| `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. |
|
| `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. |
|
| `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. |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
=== "Shared Template Variables"
|
=== "Shared Template Variables"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@ Liars" show in your library so that you have easy access to the other shows in t
|
||||||
|
|
||||||
Supported Library Types: Show
|
Supported Library Types: Show
|
||||||
|
|
||||||
## Collections
|
## <a id="collection_section"></a>Collections
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------------------------------|:----------------------------------------------------|:---------------------------------------------------|
|
|:------------------------------------------------------------|:----------------------------------------------------|:---------------------------------------------------|
|
||||||
|
|
@ -52,37 +52,37 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
|
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the [key's](#collection_section) collection.<br>**Values:** New Collection Summary |
|
||||||
| `collection_section` | **Description:** Adds a sort title with this collection sections.<br>**Values:** Any number |
|
| `collection_section` | **Description:** Adds a sort title with this collection sections.<br>**Values:** Any number |
|
||||||
| `order_<<key>>`<sup>1</sup> | **Description:** Controls the sort order of the collections in their collection section.<br>**Values:** Any number |
|
| `order_<<key>>`<sup>1</sup> | **Description:** Controls the sort order of the collections in their collection section.<br>**Values:** Any number |
|
||||||
| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
||||||
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |
|
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |
|
||||||
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the specified key's collection.<br>**Values:** Any String |
|
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the [key's](#collection_section) collection.<br>**Values:** Any String |
|
||||||
| `sort_title` | **Description:** Sets the sort title for all collections. Use `<<collection_name>>` to use the collection name. **Example:** `"!02_<<collection_name>>"`<br>**Values:** Any String with `<<collection_name>>` |
|
| `sort_title` | **Description:** Sets the sort title for all collections. Use `<<collection_name>>` to use the collection name. **Example:** `"!02_<<collection_name>>"`<br>**Values:** Any String with `<<collection_name>>` |
|
||||||
| `sort_title_<<key>>`<sup>1</sup> | **Description:** Sets the sort title of the specified key's collection.<br>**Default:** `sort_title`<br>**Values:** Any String |
|
| `sort_title_<<key>>`<sup>1</sup> | **Description:** Sets the sort title of the [key's](#collection_section) collection.<br>**Default:** `sort_title`<br>**Values:** Any String |
|
||||||
| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these shows sent to Sonarr.<br>**Values:** `false` to not build the collection |
|
| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these shows sent to Sonarr.<br>**Values:** `false` to not build the collection |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||||
| `exclude` | **Description:** Exclude these Collections from creating a Dynamic Collection.<br>**Values:** List of Collection IDs |
|
| `exclude` | **Description:** Exclude these Collections from creating a Dynamic Collection.<br>**Values:** List of Collection IDs |
|
||||||
| `data` | **Description:** Overrides the [default data dictionary](#data). Defines the data that the custom dynamic collection processes.<br>**Values:** Dictionary List of TMDb Main Show ID |
|
| `data` | **Description:** Overrides the [default data dictionary](#default-values ). Defines the data that the custom dynamic collection processes.<br>**Values:** Dictionary List of TMDb Main Show ID |
|
||||||
| `append_data` | **Description:** Appends to the [default data dictionary](#data).<br>**Values:** Dictionary List of TMDb Main Show ID |
|
| `append_data` | **Description:** Appends to the [default data dictionary](#default-values).<br>**Values:** Dictionary List of TMDb Main Show ID |
|
||||||
| `remove_data` | **Description:** Removes from the [default data dictionary](#data).<br>**Values:** List of TMDb Main Show IDs to remove |
|
| `remove_data` | **Description:** Removes from the [default data dictionary](#default-values).<br>**Values:** List of TMDb Main Show IDs to remove |
|
||||||
| `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 TMDb Show IDs |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 TMDb Show IDs |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of TMDb Show IDs |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of TMDb Show IDs |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of TMDb Show IDs |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of TMDb Show IDs |
|
||||||
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the specified key's collection.<br>**Default:** `sonarr_add_missing`<br>**Values:** `true` or `false` |
|
| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the [key's](#collection_section) collection.<br>**Default:** `sonarr_add_missing`<br>**Values:** `true` or `false` |
|
||||||
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
||||||
| `sonarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's collection.<br>**Default:** `sonarr_folder`<br>**Values:** Folder Path |
|
| `sonarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `root_folder_path` attribute of the [key's](#collection_section) collection.<br>**Default:** `sonarr_folder`<br>**Values:** Folder Path |
|
||||||
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `tag` attribute of the specified key's collection.<br>**Default:** `sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `tag` attribute of the [key's](#collection_section) collection.<br>**Default:** `sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every show found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every show found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||||
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every show found by the builders that's in Sonarr of the specified key's collection.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every show found by the builders that's in Sonarr of the [key's](#collection_section) collection.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||||
|
|
||||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
1. Each default collection has a `key` [see here]() that you must replace
|
||||||
`<<key>>` with when calling.
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
||||||
|
|
||||||
???+ example "Example Template Variable Amendments"
|
???+ example "Example Template Variable Amendments"
|
||||||
|
|
||||||
|
|
@ -111,46 +111,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `data` (click to expand) <a class="headerlink" href="#data" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<div id="data" />
|
|
||||||
|
|
||||||
```{ .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 ############
|
|
||||||
###############################################################################
|
|
||||||
data: {%
|
|
||||||
include-markdown "../../../defaults/show/franchise.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="data:"
|
|
||||||
end="template:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? 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/show/franchise.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ The `network` Default Collection File is used to dynamically create collections
|
||||||
|
|
||||||
Supported Library Types: Show
|
Supported Library Types: Show
|
||||||
|
|
||||||
## Collections Section 050
|
## <a id="collection_section"></a>Collections Section 050
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:------------------------------------|:------------------------------------|:-------------------------------------------------------------------------------|
|
|:------------------------------------|:------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -65,17 +65,17 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
| Variable | Description & Values |
|
| Variable | Description & Values |
|
||||||
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
| `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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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` |
|
| `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 |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<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 |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<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 |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<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 |
|
| `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 |
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-values). 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 |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<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 |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<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. |
|
| `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. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s broadcast on <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
|
|
@ -119,46 +119,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/show/network.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/show/network.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@ might be seen as controversial. You are welcome to edit this to fit your own aud
|
||||||
|
|
||||||
Supported Library Types: Show
|
Supported Library Types: Show
|
||||||
|
|
||||||
## Collections Section 081
|
## <a id="collection_section"></a>Collections Section 081
|
||||||
|
|
||||||
| Collection | Key | Description |
|
| Collection | Key | Description |
|
||||||
|:--------------------------------------|:--------------------------------------------------------|:-------------------------------------------------------------------------------|
|
|:--------------------------------------|:--------------------------------------------------------|:-------------------------------------------------------------------------------|
|
||||||
|
|
@ -63,19 +63,19 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `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> |
|
| `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` | **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 |
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||||
| `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` | **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) |
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `include` | **Description:** Overrides the [default include list](#default-values).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `append_include` | **Description:** Appends to the [default include list](#default-values).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `remove_include` | **Description:** Removes from the [default include list](#default-values).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `addons` | **Description:** 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `addons` | **Description:** 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-values).<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||||
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).<br>**Values:** Dictionary with `key: new_key_name` entries |
|
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-values).<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. |
|
| `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. |
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
||||||
|
|
||||||
|
|
@ -120,46 +120,8 @@ work. Any value not specified will use its default value if it has one if not it
|
||||||
|
|
||||||
## Default Values
|
## Default Values
|
||||||
|
|
||||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
Unless you customize them as described above, these collections use default lists and searches to create the collections.
|
||||||
show how to change a name or a list.**
|
|
||||||
|
|
||||||
If you want to customize these values, use the methods described above.
|
If you are interested in customizing the default values, you can find that information [here](#template-variables).
|
||||||
|
|
||||||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
If you are interested in seeing what those default builders are, you can find that information [here](../sources.md).
|
||||||
|
|
||||||
<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/show/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/show/region.yml"
|
|
||||||
comments=false
|
|
||||||
preserve-includer-indent=false
|
|
||||||
start="addons:"
|
|
||||||
%}
|
|
||||||
```
|
|
||||||
|
|
|
||||||
587
docs/defaults/sources.md
Normal file
587
docs/defaults/sources.md
Normal file
|
|
@ -0,0 +1,587 @@
|
||||||
|
# Data sources
|
||||||
|
|
||||||
|
This page is a reference showing the sources of the data used in the defaults files.
|
||||||
|
|
||||||
|
For example, if you are wondering what list is used by the Christmas Collection, you can find that information here.
|
||||||
|
|
||||||
|
Nothing on this page is required for using the defaults files, but it can be useful for understanding where the data comes from.
|
||||||
|
|
||||||
|
Nothing on this page is directly useful for customizing the defaults.
|
||||||
|
|
||||||
|
Nothing here is a code example for end user use. It all *looks* like code, since it is taken directly *from* the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use, and is expressed in a different format to the way you would customize the defaults via template variables.
|
||||||
|
|
||||||
|
## I want to customize the defaults
|
||||||
|
|
||||||
|
You will want to start [here](./guide.md).
|
||||||
|
|
||||||
|
Each default has its own set of template variables, which are used to control the behavior of that default. Those will be listed on the individual page for each default.
|
||||||
|
|
||||||
|
## I want to know what's behind the defaults
|
||||||
|
|
||||||
|
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 customize the defaults.**
|
||||||
|
|
||||||
|
Nothing here is a code example for end user use. It all *looks* like code, since it is taken directly *from* the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use.
|
||||||
|
|
||||||
|
If you want to customize these values, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
## <a id="collection_section"></a>Collections
|
||||||
|
|
||||||
|
### Seasonal Collections
|
||||||
|
|
||||||
|
The Seasonal collections are based on lists from a few different sources.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the seasonal collections, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Seasonal Collections; default section 000 (click to expand) <a class="headerlink" href="#seasonal" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="seasonal" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/movie/seasonal.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Basic Collections
|
||||||
|
|
||||||
|
The Basic collections are based on Smart Filters, not external lists.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### AniList Collections
|
||||||
|
|
||||||
|
The AniList collections use the [anilist builder](../files/builders/anilist.md) to create the collections.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### IMDB Collections
|
||||||
|
|
||||||
|
The IMDb collections use the [IMDb builder](../files/builders/imdb.md) to create the collections.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Letterboxd Collections
|
||||||
|
|
||||||
|
The Letterboxd collections use the [Letterboxd builder](../files/builders/letterboxd.md) to create the collections.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### MyAnimeList Collections
|
||||||
|
|
||||||
|
The MyAnimeList collections use the [MyAnimeList builder](../files/builders/myanimelist.md) to create the collections.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Other Chart Collections
|
||||||
|
|
||||||
|
The collections created here use a variety of sources.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
| Collection | Source |
|
||||||
|
|:------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| `AniDB Popular` | ['anidb_popular' builder](../files/builders/anidb.md) |
|
||||||
|
| `Common Sense Selection` | Sourced from mdblist:<br>`https://mdblist.com/lists/k0meta/cssfamiliesmovies` or<br>`https://mdblist.com/lists/k0meta/cssfamiliesshows` |
|
||||||
|
| `StevenLu's Popular Movies` | [`stevenlu_popular` builder](../files/builders/stevenlu.md) |
|
||||||
|
| `Top 10 Pirated Movies of the Week` | Sourced from mdblist:<br>`https://mdblist.com/lists/hdlists/top-ten-pirated-movies-of-the-week-torrent-freak-com/` |
|
||||||
|
|
||||||
|
### Tautulli Collections
|
||||||
|
|
||||||
|
The Tautulli collections use the [Tautulli builder](../files/builders/tautulli.md) to create the collections.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### TMDB Collections
|
||||||
|
|
||||||
|
The TMDB collections use the [TMDB builder](../files/builders/tmdb.md) to create the collections.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Trakt Collections
|
||||||
|
|
||||||
|
The Trakt collections use the [Trakt builder](../files/builders/trakt.md) to create the collections.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Streaming Services Collections
|
||||||
|
|
||||||
|
The Streaming Services collections use two builders to create the collections:
|
||||||
|
|
||||||
|
If you are not using `originals_only`, the collections are created using [`tmdb_discover`](../files/builders/tmdb.md).
|
||||||
|
|
||||||
|
If you are using `originals_only`, the collections are created using Kometa-maintained MDBLists.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Universes Collections
|
||||||
|
|
||||||
|
The Universe collections are based on either Trakt lists or MDB lists.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the universe collections, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Universes; default section 040 (click to expand) <a class="headerlink" href="#universe" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="universe" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/universe.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Network Collections
|
||||||
|
|
||||||
|
The Network collections use the [dynamic collections](../files/dynamic.md) system with a default include list and some default addons to consolidate some of the networks.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the network collections, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Networks; default section 050 (click to expand) <a class="headerlink" href="#network" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="network" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/show/network.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Genre Collections
|
||||||
|
|
||||||
|
The Genre collections use the [dynamic collections](../files/dynamic.md) system based on the genres found in your library and some default addons to consolidate some of the genres.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the genre collections, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Genres; default section 060 (click to expand) <a class="headerlink" href="#genre" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="genre" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/genre.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Studios Collections
|
||||||
|
|
||||||
|
The Studio collections use the [dynamic collections](../files/dynamic.md) system with a default include list and some default addons to consolidate some of the studios.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the studio collections, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Studios; default section 070 (click to expand) <a class="headerlink" href="#studio" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="studio" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/studio.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Countries Collections
|
||||||
|
|
||||||
|
The Country collections use the [dynamic collections](../files/dynamic.md) system with a default include list and some default addons to consolidate some of the countries.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the country collections, you can find them here.
|
||||||
|
|
||||||
|
The countries are stored differently for shows and movies, so there are different lists for each library type.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Countries; default section 080 (click to expand) <a class="headerlink" href="#country" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="country" />
|
||||||
|
|
||||||
|
??? example "Shows (click to expand) <a class="headerlink" href="#country-show" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="country-show" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/show/country.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
??? example "Movies (click to expand) <a class="headerlink" href="#country-movie" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="country-movie" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/movie/country.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Regions Collections
|
||||||
|
|
||||||
|
The Region collections use the [dynamic collections](../files/dynamic.md) system with a default include list and some default addons to consolidate some of the regions.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the region collections, you can find them here.
|
||||||
|
|
||||||
|
The regions are stored differently for shows and movies, so there are different lists for each library type.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Regions; default section 081 (click to expand) <a class="headerlink" href="#region" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="region" />
|
||||||
|
|
||||||
|
??? example "Shows (click to expand) <a class="headerlink" href="#region-show" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="region-show" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/show/region.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
??? example "Movies (click to expand) <a class="headerlink" href="#region-movie" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="region-movie" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/movie/region.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Continents Collections
|
||||||
|
|
||||||
|
The Continents collections use the [dynamic collections](../files/dynamic.md) system with some default addons to consolidate the countries into continents.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the continent collections, you can find them here.
|
||||||
|
|
||||||
|
The countries are stored differently for shows and movies, so there are different lists for each library type.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Continents; default section 082 (click to expand) <a class="headerlink" href="#continent" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="continent" />
|
||||||
|
|
||||||
|
??? example "Shows (click to expand) <a class="headerlink" href="#continent-show" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="continent-show" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/show/continent.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
??? example "Movies (click to expand) <a class="headerlink" href="#continent-movie" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="continent-movie" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/movie/continent.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Based On A ... Collections
|
||||||
|
|
||||||
|
The Based On A ... collections are created using Kometa-maintained MDBLists.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Audio Languages Collections
|
||||||
|
|
||||||
|
The Audio Languages collections use smart filters based on a default list of target languages
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the audio language collections, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Audio Language; default section 090 (click to expand) <a class="headerlink" href="#audio_language" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="audio_language" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/audio_language.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Subtitle Languages Collections
|
||||||
|
|
||||||
|
The Subtitle Languages collections use smart filters based on a default list of target languages
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the subtitle language collections, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Subtitle Language; default section 095 (click to expand) <a class="headerlink" href="#subtitle_language" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="subtitle_language" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/subtitle_language.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Decades Collections
|
||||||
|
|
||||||
|
The Decades collections use the [dynamic collections](../files/dynamic.md) system based on the release dates of the items in your libraries.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Yearly Collections
|
||||||
|
|
||||||
|
The Yearly collections use the [dynamic collections](../files/dynamic.md) system based on the release dates of the items in your libraries.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Content Ratings Collections
|
||||||
|
|
||||||
|
The Content Rating collections all use the [dynamic collections](../files/dynamic.md) system based on the content ratings of the items in your libraries. They each have a addons which combine all the ratings in your library into collections reflecting the desired system.
|
||||||
|
|
||||||
|
For example, if you use the US Content Ratings collection, it will create collections for each of the US content ratings, and map any non-US content ratings in your library into one of the US content ratings.
|
||||||
|
|
||||||
|
Content ratings for Movies and TV differ, so there are different lists for each library type.
|
||||||
|
|
||||||
|
??? example "US Content Ratings; default section 110 (click to expand) <a class="headerlink" href="#content_rating_us" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="content_rating_us" />
|
||||||
|
|
||||||
|
??? example "Shows (click to expand) <a class="headerlink" href="#content_rating_us-show" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="content_rating_us-show" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/show/content_rating_us.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
??? example "Movies (click to expand) <a class="headerlink" href="#content_rating_us-movie" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="content_rating_us-movie" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/movie/content_rating_us.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
??? example "UK Content Ratings; default section 110 (click to expand) <a class="headerlink" href="#content_rating_uk" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="content_rating_uk" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/content_rating_uk.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
??? example "German Content Ratings; default section 110 (click to expand) <a class="headerlink" href="#content_rating_de" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="content_rating_de" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/content_rating_de.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
??? example "MyAnimeList Content Ratings; default section 110 (click to expand) <a class="headerlink" href="#content_rating_mal" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="content_rating_mal" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/content_rating_mal.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
??? example "CommonSense Content Ratings; default section 110 (click to expand) <a class="headerlink" href="#content_rating_cs" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="content_rating_cs" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/content_rating_cs.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Resolution Collections
|
||||||
|
|
||||||
|
The Resolution collections use the [dynamic collections](../files/dynamic.md) system based on the resolution of the items in your libraries.
|
||||||
|
|
||||||
|
They use a default list of resolutions to create the collections, and some default addons to group resolutions together.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the universe collections, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Resolution; default section 120 (click to expand) <a class="headerlink" href="#resolution" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="resolution" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/resolution.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Aspect Ratios Collections
|
||||||
|
|
||||||
|
The Aspect Ratio collections use Plex searches and filters based on a fixed list of aspect ratios.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Awards Collections
|
||||||
|
|
||||||
|
All the Awards collections use the [IMDb Awards builder](../files/builders/imdb.md) to create the collections.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Actors/Directors/Producers/Writers Collections
|
||||||
|
|
||||||
|
All the Awards collections use the [dynamic collections](../files/dynamic.md) system based on the Actors/Directors/Producers/Writers in your library.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
### Franchises Collections
|
||||||
|
|
||||||
|
The Continents collections use the [dynamic collections](../files/dynamic.md) system with a default list of target franchises and some default addons to group shows and movies into those franchises.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the franchise collections, you can find them here.
|
||||||
|
|
||||||
|
The franchises are different for shows and movies, so there are different lists for each library type.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Franchises; NO default section (click to expand) <a class="headerlink" href="#franchise" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="franchise" />
|
||||||
|
|
||||||
|
??? example "Shows (click to expand) <a class="headerlink" href="#franchise-show" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="franchise-show" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/show/franchise.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
??? example "Movies (click to expand) <a class="headerlink" href="#franchise-movie" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="franchise-movie" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/movie/franchise.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
### Collectionless Collections
|
||||||
|
|
||||||
|
The Collectionless collections use the [`plex_collectionless` builder](../files/builders/plex.md) to create the collection.
|
||||||
|
|
||||||
|
Collections and their items are excluded from this collection based on a name prefix or the collection name.
|
||||||
|
|
||||||
|
If you are interested in seeing the default prefixes that are used for the collectionless collections, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Collectionless; no default section (click to expand) <a class="headerlink" href="#collectionless" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="collectionless" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/both/collectionless.md"
|
||||||
|
%}
|
||||||
|
|
||||||
|
## Overlays
|
||||||
|
|
||||||
|
Most overlays are based on Plex searches and filters; they typically assume TRaSH naming conventions.
|
||||||
|
|
||||||
|
### aspect Overlays
|
||||||
|
|
||||||
|
[`plex_search` builder](../files/builders/plex.md) with filters on a limited set of aspect ratios.
|
||||||
|
|
||||||
|
### audio_codec Overlays
|
||||||
|
|
||||||
|
[`plex_all` builder](../files/builders/plex.md) with filters on both audio channel name and filepath.
|
||||||
|
|
||||||
|
### Content Rating Overlays
|
||||||
|
|
||||||
|
All Content Rating overlays are based on Plex searches; they all search for a set of content ratings and map them into a single content rating as requested.
|
||||||
|
|
||||||
|
### direct_play Overlays
|
||||||
|
|
||||||
|
[`plex_search` builder](../files/builders/plex.md) for 4K items.
|
||||||
|
|
||||||
|
### episode_info Overlays
|
||||||
|
|
||||||
|
Applies to every episode in the library.
|
||||||
|
|
||||||
|
### language_count Overlays
|
||||||
|
|
||||||
|
[`plex_search` builder](../files/builders/plex.md) for items with any number or <3 audio tracks.
|
||||||
|
|
||||||
|
### languages Overlays
|
||||||
|
|
||||||
|
[`plex_search` builder](../files/builders/plex.md) on either audio or subtitle tracks names.
|
||||||
|
|
||||||
|
### mediastinger Overlays
|
||||||
|
|
||||||
|
[`plex_all` builder](../files/builders/plex.md) with filters on `tmdb_keyword: aftercreditsstinger, duringcreditsstinger`
|
||||||
|
|
||||||
|
### network Overlays
|
||||||
|
|
||||||
|
[`plex_search` builder](../files/builders/plex.md) on network name. The list of networks is not exposed for customization using template variables.
|
||||||
|
|
||||||
|
### ratings Overlays
|
||||||
|
|
||||||
|
[`plex_search` builder](../files/builders/plex.md) on ratings as set on items in Plex.
|
||||||
|
|
||||||
|
### resolution Overlays
|
||||||
|
|
||||||
|
[`plex_search` builder](../files/builders/plex.md) on resolutions and editions as set on items in Plex.
|
||||||
|
|
||||||
|
### ribbon Overlays
|
||||||
|
|
||||||
|
For the most part, based on the [IMDb Award builder](../files/builders/imdb.md).
|
||||||
|
|
||||||
|
### runtimes Overlays
|
||||||
|
|
||||||
|
Applies to every item in the library.
|
||||||
|
|
||||||
|
### status Overlays
|
||||||
|
|
||||||
|
Applies to every show in the library; uses the [`tmdb_status` builder](../files/builders/tmdb.md).
|
||||||
|
|
||||||
|
### streaming Overlays
|
||||||
|
|
||||||
|
The Streaming Services overlays use two builders:
|
||||||
|
|
||||||
|
If you are not using `originals_only`, the overlays are applied using [`tmdb_discover`](../files/builders/tmdb.md).
|
||||||
|
|
||||||
|
If you are using `originals_only`, the overlays are applied using Kometa-maintained MDBLists.
|
||||||
|
|
||||||
|
### studio Overlays
|
||||||
|
|
||||||
|
[`plex_search` builder](../files/builders/plex.md) on studio name. The list of studio is not exposed for customization using template variables.
|
||||||
|
|
||||||
|
### versions Overlays
|
||||||
|
|
||||||
|
[`plex_search` builder](../files/builders/plex.md) for duplicate items or episodes.
|
||||||
|
|
||||||
|
### video_format Overlays
|
||||||
|
|
||||||
|
[`plex_all` builder](../files/builders/plex.md) with filters on filepath.
|
||||||
|
|
||||||
|
## Playlists
|
||||||
|
|
||||||
|
The default playlists are based on Trakt lists.
|
||||||
|
|
||||||
|
If you are interested in seeing the lists that are used for the default playlists, you can find them here.
|
||||||
|
|
||||||
|
These lists are provided for reference.
|
||||||
|
|
||||||
|
If you want to customize these collections, refer to [this](#i-want-to-customize-the-defaults).
|
||||||
|
|
||||||
|
??? example "Playlists (click to expand) <a class="headerlink" href="#playlist" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="playlist" />
|
||||||
|
|
||||||
|
{%
|
||||||
|
include-markdown "./sources/playlist.md"
|
||||||
|
%}
|
||||||
1
docs/defaults/sources/award/bafta.md
Normal file
1
docs/defaults/sources/award/bafta.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# British Academy of Film and Television Arts Awards Collections
|
||||||
1
docs/defaults/sources/award/berlinale.md
Normal file
1
docs/defaults/sources/award/berlinale.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Berlin International Film Festival Awards Collections
|
||||||
1
docs/defaults/sources/award/cannes.md
Normal file
1
docs/defaults/sources/award/cannes.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Cannes Awards Collections
|
||||||
1
docs/defaults/sources/award/cesar.md
Normal file
1
docs/defaults/sources/award/cesar.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# César Awards Collections
|
||||||
1
docs/defaults/sources/award/choice.md
Normal file
1
docs/defaults/sources/award/choice.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Critics Choice Awards Collections
|
||||||
1
docs/defaults/sources/award/emmy.md
Normal file
1
docs/defaults/sources/award/emmy.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Emmy Awards Collections
|
||||||
1
docs/defaults/sources/award/golden.md
Normal file
1
docs/defaults/sources/award/golden.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Golden Globes Awards Collections
|
||||||
1
docs/defaults/sources/award/nfr.md
Normal file
1
docs/defaults/sources/award/nfr.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# National Film Registry Collections
|
||||||
1
docs/defaults/sources/award/oscars.md
Normal file
1
docs/defaults/sources/award/oscars.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Academy Awards (Oscars) Collections
|
||||||
1
docs/defaults/sources/award/pca.md
Normal file
1
docs/defaults/sources/award/pca.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# People's Choice Awards Collections
|
||||||
1
docs/defaults/sources/award/razzie.md
Normal file
1
docs/defaults/sources/award/razzie.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Razzie Awards Collections
|
||||||
1
docs/defaults/sources/award/sag.md
Normal file
1
docs/defaults/sources/award/sag.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Screen Actors Guild Awards Collections
|
||||||
1
docs/defaults/sources/award/separator.md
Normal file
1
docs/defaults/sources/award/separator.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Award Separator Collections
|
||||||
1
docs/defaults/sources/award/spirit.md
Normal file
1
docs/defaults/sources/award/spirit.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Independent Spirit Awards Collections
|
||||||
1
docs/defaults/sources/award/sundance.md
Normal file
1
docs/defaults/sources/award/sundance.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Sundance Film Festival Awards Collections
|
||||||
1
docs/defaults/sources/award/tiff.md
Normal file
1
docs/defaults/sources/award/tiff.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Toronto International Film Festival Awards Collections
|
||||||
1
docs/defaults/sources/award/venice.md
Normal file
1
docs/defaults/sources/award/venice.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Venice Film Festival Awards Collections
|
||||||
1
docs/defaults/sources/both/actor.md
Normal file
1
docs/defaults/sources/both/actor.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Actor Collections
|
||||||
1
docs/defaults/sources/both/aspect.md
Normal file
1
docs/defaults/sources/both/aspect.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Aspect Ratio Collections
|
||||||
45
docs/defaults/sources/both/audio_language.md
Normal file
45
docs/defaults/sources/both/audio_language.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# Audio Language Collections
|
||||||
|
|
||||||
|
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/both/audio_language.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="include:"
|
||||||
|
end="key_name_override:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
|
|
||||||
|
??? example "Default `key_name_override` (click to expand) <a class="headerlink" href="#key-name-override" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="key-name-override" />
|
||||||
|
|
||||||
|
```{ .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 ############
|
||||||
|
###############################################################################
|
||||||
|
key_name_override: {%
|
||||||
|
include-markdown "../../../../defaults/both/audio_language.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="key_name_override:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
1
docs/defaults/sources/both/based.md
Normal file
1
docs/defaults/sources/both/based.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Based On... Collections
|
||||||
27
docs/defaults/sources/both/collectionless.md
Normal file
27
docs/defaults/sources/both/collectionless.md
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
# Collectionless Collection
|
||||||
|
|
||||||
|
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 `exclude_prefix` (click to expand) <a class="headerlink" href="#exclude-prefix" title="Permanent link">¶</a>"
|
||||||
|
|
||||||
|
<div id="exclude-prefix" />
|
||||||
|
|
||||||
|
```{ .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-markdown "../../../../defaults/both/collectionless.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=true
|
||||||
|
dedent=true
|
||||||
|
start="# check1"
|
||||||
|
end="# check2"
|
||||||
|
%}
|
||||||
|
```
|
||||||
45
docs/defaults/sources/both/content_rating_au.md
Normal file
45
docs/defaults/sources/both/content_rating_au.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# AU Content Rating Collections
|
||||||
|
|
||||||
|
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/both/content_rating_au.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/both/content_rating_au.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="addons:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
45
docs/defaults/sources/both/content_rating_cs.md
Normal file
45
docs/defaults/sources/both/content_rating_cs.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# Common Sense Media Content Rating Collections
|
||||||
|
|
||||||
|
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/both/content_rating_cs.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/both/content_rating_cs.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="addons:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
45
docs/defaults/sources/both/content_rating_de.md
Normal file
45
docs/defaults/sources/both/content_rating_de.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# DE Content Rating Collections
|
||||||
|
|
||||||
|
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/both/content_rating_de.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/both/content_rating_de.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="addons:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
45
docs/defaults/sources/both/content_rating_mal.md
Normal file
45
docs/defaults/sources/both/content_rating_mal.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# MAL Content Rating Collections
|
||||||
|
|
||||||
|
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/both/content_rating_mal.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/both/content_rating_mal.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="addons:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
45
docs/defaults/sources/both/content_rating_nz.md
Normal file
45
docs/defaults/sources/both/content_rating_nz.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# NZ Content Rating Collections
|
||||||
|
|
||||||
|
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/both/content_rating_nz.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/both/content_rating_nz.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="addons:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
45
docs/defaults/sources/both/content_rating_uk.md
Normal file
45
docs/defaults/sources/both/content_rating_uk.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# UK Content Rating Collections
|
||||||
|
|
||||||
|
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/both/content_rating_uk.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/both/content_rating_uk.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="addons:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
25
docs/defaults/sources/both/genre.md
Normal file
25
docs/defaults/sources/both/genre.md
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
# Genre Collections
|
||||||
|
|
||||||
|
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 `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/both/genre.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="addons:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
39
docs/defaults/sources/both/resolution.md
Normal file
39
docs/defaults/sources/both/resolution.md
Normal file
|
|
@ -0,0 +1,39 @@
|
||||||
|
# Resolution Collections
|
||||||
|
|
||||||
|
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" />
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
include: {%
|
||||||
|
include-markdown "../../../../defaults/both/resolution.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/both/resolution.yml"
|
||||||
|
comments=false
|
||||||
|
preserve-includer-indent=false
|
||||||
|
start="addons:"
|
||||||
|
%}
|
||||||
|
```
|
||||||
1
docs/defaults/sources/both/streaming.md
Normal file
1
docs/defaults/sources/both/streaming.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Streaming Collections
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue