Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add more wiki pages, fixed missin `- pmm:` in references

Browse Source
pull/1100/head
YozoraXCII 2 years ago
parent 18e5f92b6b
commit fe53988430
41 changed files with 173 additions and 385 deletions
Show Stats Download Patch File Download Diff File

4
docs/defaults/award/bafta.md
Unescape View File

@ -1,6 +1,6 @@
# British Academy of Film and Television Arts Default Metadata File # British Academy of Film and Television Arts Default Metadata File
The `bafta` Metadata File is used to create collections based on the British Academy of Film and Television Arts Awards. The `- pmm: bafta` Metadata File is used to create collections based on the British Academy of Film and Television Arts Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `collection_order` | **Description:** Changes the 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](../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<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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/award/cannes.md
Unescape View File

@ -1,6 +1,6 @@
# Cannes Default Metadata File # Cannes Default Metadata File
The `cannes` Metadata File is used to create collections based on the Cannes Film Awards. The `- pmm: cannes` Metadata File is used to create collections based on the Cannes Film Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `collection_order` | **Description:** Changes the 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](../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<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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/award/choice.md
Unescape View File

@ -1,6 +1,6 @@
# Critics Choice Default Metadata File # Critics Choice Default Metadata File
The `choice` Metadata File is used to create collections based on the Critics Choice Awards. The `- pmm: choice` Metadata File is used to create collections based on the Critics Choice Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
@ -42,7 +42,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `collection_order` | **Description:** Changes the 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](../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<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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/award/emmy.md
Unescape View File

@ -1,6 +1,6 @@
# Emmys Default Metadata File # Emmys Default Metadata File
The `emmy` Metadata File is used to create collections based on the Emmy Awards. The `- pmm: emmy` Metadata File is used to create collections based on the Emmy Awards.
This file works with Movie and TV Libraries. This file works with Movie and TV Libraries.
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `collection_order` | **Description:** Changes the 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](../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<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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/award/golden.md
Unescape View File

@ -1,6 +1,6 @@
# Golden Globes Default Metadata File # Golden Globes Default Metadata File
The `golden` Metadata File is used to create collections based on the Golden Globe Awards. The `- pmm: golden` Metadata File is used to create collections based on the Golden Globe Awards.
The `Golden Globe Best Motion Pictures` only works with Movie Libraries but the year collections work with both Movie and TV libraries. The `Golden Globe Best Motion Pictures` only works with Movie Libraries but the year collections work with both Movie and TV libraries.
@ -41,7 +41,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `collection_order` | **Description:** Changes the 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](../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<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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/award/oscars.md
Unescape View File

@ -1,6 +1,6 @@
# Academy Awards (Oscars) Default Metadata File # Academy Awards (Oscars) Default Metadata File
The `oscars` Metadata File is used to create collections based on the Academy Awards (Oscars). The `- pmm: oscars` Metadata File is used to create collections based on the Academy Awards (Oscars).
This file only works with Movie Libraries. This file only works with Movie Libraries.
@ -38,7 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `collection_order` | **Description:** Changes the 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](../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<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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/award/other.md
Unescape View File

@ -1,6 +1,6 @@
# Other Awards Default Metadata File # Other Awards Default Metadata File
The `other_award` Metadata File is used to create collections based on numerous other awards. The `- pmm: other_award` Metadata File is used to create collections based on numerous other awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)

4
docs/defaults/award/spirit.md
Unescape View File

@ -1,6 +1,6 @@
# Independent Spirit Awards Default Metadata File # Independent Spirit Awards Default Metadata File
The `spirit` Metadata File is used to create collections based on the Independent Spirit Awards. The `- pmm: spirit` Metadata File is used to create collections based on the Independent Spirit Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
@ -39,7 +39,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `collection_order` | **Description:** Changes the 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](../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<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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/award/sundance.md
Unescape View File

@ -1,6 +1,6 @@
# Sundance Film Festival Awards Default Metadata File # Sundance Film Festival Awards Default Metadata File
The `sundance` Metadata File is used to create collections based on the Sundance Film Festival Awards. The `- pmm: sundance` Metadata File is used to create collections based on the Sundance Film Festival Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `collection_order` | **Description:** Changes the 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](../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<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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/actor.md
Unescape View File

@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><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>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> | | `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><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>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/audio_language.md
Unescape View File

@ -30,7 +30,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/content_rating_cs.md
Unescape View File

@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library | | `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/content_rating_uk.md
Unescape View File

@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library | | `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/genre.md
Unescape View File

@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Genre found in your library | | `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Genre found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Genre found in your library | | `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Genre found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/resolution.md
Unescape View File

@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Resolution found in your library | | `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Resolution found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Resolution found in your library | | `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Resolution found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/resolution_standards.md
Unescape View File

@ -36,7 +36,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Resolution found in your library | | `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Resolution found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Resolution found in your library | | `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Resolution found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/streaming.md
Unescape View File

@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available using the below keys.
| paramount | Paramount+ | | paramount | Paramount+ |
| peacock | Peacock | | peacock | Peacock |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/studio.md
Unescape View File

@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Studio found in your library | | `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Studio found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Studio found in your library | | `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Studio found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/subtitle_language.md
Unescape View File

@ -30,7 +30,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

2
docs/defaults/both/year.md
Unescape View File

@ -28,7 +28,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<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>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-10</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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:** Changes the following values of the collection builder<br>**Values:**<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>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-10</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</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> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/chart/anilist.md
Unescape View File

@ -42,7 +42,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of anilist charts) | | order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of anilist charts) |
| summary_key | Determines summary of collection | | Any summary text | | summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number | | limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | | | collection_order | Determines collection order of the collection | | |
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | | visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | | visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | | visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
@ -57,7 +57,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | | collection_section | Controls the sort order of these collections against other default collections | `01` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items | | collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/chart/basic.md
Unescape View File

@ -40,7 +40,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_released` to put released first in the list of charts) | | order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_released` to put released first in the list of charts) |
| summary_key | Determines summary of collection | | Any summary text | | summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number | | limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | | | collection_order | Determines collection order of the collection | | |
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | | visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | | visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | | visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
@ -49,7 +49,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | | collection_section | Controls the sort order of these collections against other default collections | `01` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items | | collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/chart/imdb.md
Unescape View File

@ -41,7 +41,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of imdb charts) | | order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of imdb charts) |
| summary_key | Determines summary of collection | | Any summary text | | summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number | | limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | | | collection_order | Determines collection order of the collection | | |
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | | visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | | visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | | visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
@ -56,7 +56,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | | collection_section | Controls the sort order of these collections against other default collections | `01` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items | | collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/chart/myanimelist.md
Unescape View File

@ -43,7 +43,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of myanimelist charts) | | order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of myanimelist charts) |
| summary_key | Determines summary of collection | | Any summary text | | summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number | | limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | | | collection_order | Determines collection order of the collection | | |
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | | visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | | visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | | visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
@ -58,7 +58,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | | collection_section | Controls the sort order of these collections against other default collections | `01` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items | | collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/chart/other.md
Unescape View File

@ -38,7 +38,7 @@ Below are the available variables which can be used to customize the file. Note
| use_key | Turn the collection on/off | `true` | `true` or `false` | | use_key | Turn the collection on/off | `true` | `true` or `false` |
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_commonsense` to put commonsense first in the list of other charts) | | order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_commonsense` to put commonsense first in the list of other charts) |
| summary_key | Determines summary of collection | | Any summary text | | summary_key | Determines summary of collection | | Any summary text |
| collection_order_key | Determines collection order of the collection | | | | collection_order | Determines collection order of the collection | | |
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | | visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | | visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | | visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
@ -53,7 +53,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | | collection_section | Controls the sort order of these collections against other default collections | `01` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items | | collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/chart/tautulli.md
Unescape View File

@ -40,7 +40,7 @@ Below are the available variables which can be used to customize the file. Note
| limit_key | Determines limit of collection | `100` | Any number | | limit_key | Determines limit of collection | `100` | Any number |
| list_days_key | Set list_days for the collection | `30` | Any number | | list_days_key | Set list_days for the collection | `30` | Any number |
| list_size_key | Set list_size for the collection | `20` | Any number | | list_size_key | Set list_size for the collection | `20` | Any number |
| collection_order_key | Determines collection order of the collection | | | | collection_order | Determines collection order of the collection | | |
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | | visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | | visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | | visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
@ -49,7 +49,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against tautulli default collections | `01` | Any number | | collection_section | Controls the sort order of these collections against tautulli default collections | `01` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items | | collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/chart/tmdb.md
Unescape View File

@ -43,7 +43,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of tmdb charts) | | order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of tmdb charts) |
| summary_key | Determines summary of collection | | Any summary text | | summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number | | limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | | | collection_order | Determines collection order of the collection | | |
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | | visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | | visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | | visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
@ -58,7 +58,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | | collection_section | Controls the sort order of these collections against other default collections | `01` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items | | collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

4
docs/defaults/chart/trakt.md
Unescape View File

@ -43,7 +43,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of trakt charts) | | order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of trakt charts) |
| summary_key | Determines summary of collection | | Any summary text | | summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number | | limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | | | collection_order | Determines collection order of the collection | | |
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | | visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | | visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | | visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
@ -58,7 +58,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | | collection_section | Controls the sort order of these collections against other default collections | `01` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items | | collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
The below shows an example config.yml with all the template_variables set away from their defaults: The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:

43
docs/defaults/movie/content_rating_us.md
Unescape View File

@ -22,20 +22,19 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
| `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:** Any Content Rating found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
| Variable | Usage | Default Value | Values | The below is an example config.yml extract with some template_variables changed from their defaults.
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `14` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_radarr_tag | rADARR Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
@ -43,6 +42,9 @@ libraries:
metadata_path: metadata_path:
- pmm: content_rating_us - pmm: content_rating_us
template_variables: template_variables:
addons:
R:
- "de/18"
sort_by: title.asc sort_by: title.asc
collection_section: 25 collection_section: 25
collection_mode: show_items collection_mode: show_items
@ -51,20 +53,3 @@ libraries:
sep_style: blue sep_style: blue
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `content_rating_us` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/content_rating_us.yml)
An example of this is; to map the "de/18" content rating to "R", the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_us
template_variables:
addons:
R:
- "de/18"
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)

45
docs/defaults/movie/country.md
Unescape View File

@ -23,21 +23,19 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
| `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:** Any Content Rating found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
| Variable | Usage | Default Value | Values | The below is an example config.yml extract with some template_variables changed from their defaults.
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| style | Controls the visual theme of the collections created | `white` | `white` or `color` |
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `13` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_radarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
@ -45,27 +43,12 @@ libraries:
metadata_path: metadata_path:
- pmm: country - pmm: country
template_variables: template_variables:
exclude:
- fr
sort_by: title.asc sort_by: title.asc
collection_section: 8 collection_section: 8
collection_mode: show_items collection_mode: show_items
use_other: false use_other: false
use_separator: false use_separator: false
sep_style: purple sep_style: purple
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `country` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/country.yml)
An example of this is; to override the exclude list to only exclude Barbados from the collection list, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: country
template_variables:
exclude:
- Barbados
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)

34
docs/defaults/movie/decade.md
Unescape View File

@ -20,20 +20,14 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| Variable | Usage | Default Value | Values | The below is an example config.yml extract with some template_variables changed from their defaults.
|:-------------------|:-----------------------------------------------------------------------------------------------------|------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `audience_rating.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `12` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_radarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
@ -47,20 +41,4 @@ libraries:
use_other: false use_other: false
use_separator: false use_separator: false
sep_style: purple sep_style: purple
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `decade` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/decade.yml)
An example of this is; to change the collection titles to "Best Movies of <decade>, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: decade
template_variables:
title_format: Best <<library_type>>s of <<key_name>>
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)

41
docs/defaults/movie/director.md
Unescape View File

@ -25,20 +25,17 @@ Template Variables can be used to manipulate the director file from the default
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Usage | Default Value | Values | | Variable | Description & Values |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| |:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme | | `style ` | **Description:** Controls the visual theme of the collections created<br>**Values:**`bw` - Black and white theme or</br>`rainier` - Rainier theme |
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) | | `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `17` | Any number | | `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><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>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:
@ -46,27 +43,13 @@ libraries:
metadata_path: metadata_path:
- pmm: director - pmm: director
template_variables: template_variables:
data:
depth: 10
limit: 20
style: rainier style: rainier
sort_by: title.asc sort_by: title.asc
collection_section: 12 collection_section: 12
collection_mode: show_items collection_mode: show_items
use_separator: false use_separator: false
sep_style: purple sep_style: purple
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `director` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/director.yml)
An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: director
template_variables:
data:
limit: 25
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)

18
docs/defaults/movie/franchise.md
Unescape View File

@ -22,21 +22,9 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available
The below is an example config.yml extract with some template_variables changed from their defaults.
| Variable | Usage | Default Value | Values |
|:-------------------|:----------------------------------------------|---------------|:----------------------------------------------:|
| collection_order | Sets the collection order of the collection | `release` | `release`, `alpha` or `custom` |
| sort_title | Sets the sort title | | Desired sort title |
| minimum_items | Sets the minimum items of the collection | `2` | Any number |
| build_collection | Sets weather to actually build the collection | `true` | `true` or `false` |
| radarr_add_missing | Adds missing from the collection to radarr | `false` | `true` or `false` |
| radarr_folder | Radarr Folder to add to | | Folder to add missing items to |
| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to existing items |
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
@ -48,7 +36,7 @@ libraries:
sort_title: "!10_<<collection_name>>" sort_title: "!10_<<collection_name>>"
build_collection: false build_collection: false
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/TV radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>> radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>> item_radarr_tag: <<collection_name>>
``` ```

41
docs/defaults/movie/producer.md
Unescape View File

@ -25,20 +25,17 @@ Template Variables can be used to manipulate the producer file from the default
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Usage | Default Value | Values | | Variable | Description & Values |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| |:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme | | `style ` | **Description:** Controls the visual theme of the collections created<br>**Values:**`bw` - Black and white theme or</br>`rainier` - Rainier theme |
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) | | `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `17` | Any number | | `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><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>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:
@ -46,27 +43,13 @@ libraries:
metadata_path: metadata_path:
- pmm: producer - pmm: producer
template_variables: template_variables:
data:
depth: 10
limit: 20
style: rainier style: rainier
sort_by: title.asc sort_by: title.asc
collection_section: 12 collection_section: 12
collection_mode: show_items collection_mode: show_items
use_separator: false use_separator: false
sep_style: purple sep_style: purple
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `producer` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/producer.yml)
An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: producer
template_variables:
data:
limit: 25
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)

16
docs/defaults/movie/universe.md
Unescape View File

@ -22,20 +22,10 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available
The below is an example config.yml extract with some template_variables changed from their defaults.
| Variable | Usage | Default Value | Values |
|:-------------------|:---------------------------------------------|---------------|:-------------------------------------------------------:|
| collection_order | Sets the collection order of the collection | `alpha` | `release`, `alpha` or `custom` |
| radarr_add_missing | Adds missing from the collection to radarr | `false` | `true` or `false` |
| radarr_folder | Radarr Folder to add to | | Folder to add missing items to |
| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items |
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
@ -45,7 +35,7 @@ libraries:
template_variables: template_variables:
collection_order: release collection_order: release
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/TV radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>> radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>> item_radarr_tag: <<collection_name>>
use_separator: false use_separator: false

41
docs/defaults/movie/writer.md
Unescape View File

@ -25,20 +25,17 @@ Template Variables can be used to manipulate the writer file from the default se
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Usage | Default Value | Values | | Variable | Description & Values |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| |:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme | | `style ` | **Description:** Controls the visual theme of the collections created<br>**Values:**`bw` - Black and white theme or</br>`rainier` - Rainier theme |
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) | | `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `17` | Any number | | `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><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>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml ```yaml
libraries: libraries:
@ -46,27 +43,13 @@ libraries:
metadata_path: metadata_path:
- pmm: writer - pmm: writer
template_variables: template_variables:
data:
depth: 10
limit: 20
style: rainier style: rainier
sort_by: title.asc sort_by: title.asc
collection_section: 12 collection_section: 12
collection_mode: show_items collection_mode: show_items
use_separator: false use_separator: false
sep_style: purple sep_style: purple
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `writer` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/writer.yml)
An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: writer
template_variables:
data:
limit: 25
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)

50
docs/defaults/show/content_rating_us.md
Unescape View File

@ -22,51 +22,33 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
| `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:** Any Content Rating found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
| Variable | Usage | Default Value | Values | The below is an example config.yml extract with some template_variables changed from their defaults.
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `14` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
metadata_path: metadata_path:
- pmm: show/content_rating_us - pmm: content_rating_us
template_variables: template_variables:
addons:
R:
- "de/18"
sort_by: title.asc sort_by: title.asc
collection_section: 25 collection_section: 25
collection_mode: show_items collection_mode: show_items
use_other: false use_other: false
use_separator: false use_separator: false
sep_style: blue sep_style: blue
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `content_rating_us` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/content_rating_us.yml)
An example of this is; to map the "de/18" content rating to "TV-MA", the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/content_rating_us
template_variables:
addons:
TV-MA:
- "de/18"
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)

47
docs/defaults/show/country.md
Unescape View File

@ -23,49 +23,32 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
| `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:** Any Content Rating found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
| Variable | Usage | Default Value | Values | The below is an example config.yml extract with some template_variables changed from their defaults.
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| style | Controls the visual theme of the collections created | `white` | `white` or `color` |
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `13` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
metadata_path: metadata_path:
- pmm: show/country - pmm: country
template_variables: template_variables:
exclude:
- fr
sort_by: title.asc sort_by: title.asc
collection_section: 8 collection_section: 8
collection_mode: show_items collection_mode: show_items
use_other: false use_other: false
use_separator: false use_separator: false
sep_style: purple sep_style: purple
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `country` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/country.yml)
An example of this is; to include Barbados in the collection list, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/country
template_variables:
include:
- bb
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)

35
docs/defaults/show/decade.md
Unescape View File

@ -20,20 +20,13 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| Variable | Usage | Default Value | Values | The below is an example config.yml extract with some template_variables changed from their defaults.
|:-------------------|:-----------------------------------------------------------------------------------------------------|------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `audience_rating.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `12` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
@ -47,20 +40,4 @@ libraries:
use_other: false use_other: false
use_separator: false use_separator: false
sep_style: purple sep_style: purple
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `decade` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/decade.yml)
An example of this is; to change the collection titles to "Best Movies of <decade>, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/decade
template_variables:
title_format: Best <<library_type>>s of <<key_name>>
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)

16
docs/defaults/show/franchise.md
Unescape View File

@ -22,21 +22,9 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available
The below is an example config.yml extract with some template_variables changed from their defaults.
| Variable | Usage | Default Value | Values |
|:-------------------|:-------------------------------------------------------------------------------|---------------|:----------------------------------------------:|
| collection_order | Sets the collection order of the collection | `release` | `release`, `alpha` or `custom` |
| sort_title | Sets the sort title | | Desired sort title |
| minimum_items | Sets the minimum items of the collection | `2` | Any number |
| build_collection | Sets weather to actually build the collection | `true` | `true` or `false` |
| sonarr_add_missing | Adds missing from the collection to sonarr | `false` | `true` or `false` |
| sonarr_folder | Sonarr Folder to add to | | Folder to add missing items to |
| sonarr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to existing items |
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:

43
docs/defaults/show/network.md
Unescape View File

@ -20,20 +20,19 @@ Template Variables can be used to manipulate the file from the default settings
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file. All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
| `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:** Any Content Rating found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
| Variable | Usage | Default Value | Values | The below is an example config.yml extract with some template_variables changed from their defaults.
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `04` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
@ -41,26 +40,12 @@ libraries:
metadata_path: metadata_path:
- pmm: show/show/network - pmm: show/show/network
template_variables: template_variables:
append_exclude:
- BBC
sort_by: title.asc sort_by: title.asc
collection_section: 07 collection_section: 07
collection_mode: show_items collection_mode: show_items
use_other: false use_other: false
use_separator: false use_separator: false
sep_style: stb sep_style: stb
``` ```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `network` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/network.yml)
An example of this is; to rename the "BBC" netowrk to "BBC Worldwide", the following template variables can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/show/network
template_variables:
name_mapping:
- BBC: BBC Worldwide
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
Write Preview
Loading…
Cancel
Save