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

Amend Template Variables table for awards

Browse Source
pull/1094/head
YozoraXCII 2 years ago
parent 0bfd0ba1ef
commit eb8c0e3437
10 changed files with 101 additions and 189 deletions
Show Stats Download Patch File Download Diff File

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

@ -32,11 +32,11 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Variables](../variables) are available as well as the additional Variables below 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 | | Variable | Description & Values |
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `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 Collection Order<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 0</td></tr><tr><td><code>ending</code></td><td><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> 1</td></tr><tr><td><code>increment</code></td><td><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 values of the collections<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-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 shows an example config.yml with all the template_variables set away from their defaults:

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

@ -17,24 +17,20 @@ libraries:
``` ```
## Template Variables ## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Template Variables can be used to manipulate the file from the default settings which are provided.
Below are the available variables which can be used to customize the file. Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
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 |
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | | `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_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 | | `data` | **Description:** Changes the values of the collections<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-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> |
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:
@ -44,12 +40,8 @@ libraries:
metadata_path: metadata_path:
- pmm: cannes - pmm: cannes
template_variables: template_variables:
collection_section: 9 collection_section: 8
collection_mode: show_items collection_mode: show_items
collection_order: alpha collection_order: alpha
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
``` ```

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

@ -18,28 +18,18 @@ libraries:
## Template Variables ## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
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. Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
| Variable | Usage | Default Value | Values | All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 |
| 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 |
| sonrr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to missing items |
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
| Variable | Description & Values |
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `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 values of the collections<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-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 shows an example config.yml with all the template_variables set away from their defaults:
@ -49,16 +39,10 @@ libraries:
metadata_path: metadata_path:
- pmm: choice - pmm: choice
template_variables: template_variables:
collection_section: 9 collection_section: 8
collection_mode: show_items collection_mode: show_items
collection_order: alpha collection_order: alpha
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
sonarr_add_missing: true
sonarr_folder: /mnt/local/Media/TV
sonarr_tag: <<collection_name>>
item_sonarr_tag: <<collection_name>>
``` ```

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

@ -16,29 +16,18 @@ libraries:
## Template Variables ## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
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. Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
| Variable | Usage | Default Value | Values | All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|:---------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |0
| imdb_sort | Sets the sort of the IMDb Search | `moviemeter,desc ` | Any IMDb Search Sort Option |0
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 |
| 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 |
| sonrr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to missing items |
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
| Variable | Description & Values |
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `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 values of the collections<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-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 shows an example config.yml with all the template_variables set away from their defaults:
@ -48,17 +37,10 @@ libraries:
metadata_path: metadata_path:
- pmm: emmy - pmm: emmy
template_variables: template_variables:
collection_section: 9 collection_section: 8
collection_mode: show_items collection_mode: show_items
collection_order: alpha collection_order: alpha
imdb_sort: moviemeter,asc
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
sonarr_add_missing: true
sonarr_folder: /mnt/local/Media/TV
sonarr_tag: <<collection_name>>
item_sonarr_tag: <<collection_name>>
``` ```

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

@ -16,29 +16,18 @@ libraries:
## Template Variables ## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
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. Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
| Variable | Usage | Default Value | Values | All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|:---------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |0
| imdb_sort | Sets the sort of the IMDb Search | `moviemeter,desc ` | Any IMDb Search Sort Option |0
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 |
| 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 |
| sonrr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to missing items |
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
| Variable | Description & Values |
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `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 values of the collections<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-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 shows an example config.yml with all the template_variables set away from their defaults:
@ -48,17 +37,10 @@ libraries:
metadata_path: metadata_path:
- pmm: golden - pmm: golden
template_variables: template_variables:
collection_section: 9 collection_section: 8
collection_mode: show_items collection_mode: show_items
collection_order: alpha collection_order: alpha
imdb_sort: moviemeter,asc
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
sonarr_add_missing: true
sonarr_folder: /mnt/local/Media/TV
sonarr_tag: <<collection_name>>
item_sonarr_tag: <<collection_name>>
``` ```

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

@ -16,24 +16,18 @@ libraries:
## Template Variables ## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Template Variables can be used to manipulate the file from the default settings which are provided.
Below are the available variables which can be used to customize the file. Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
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 |
|:---------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |0 | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| imdb_sort | Sets the sort of the IMDb Search | `moviemeter,desc ` | Any IMDb Search Sort Option |0 | `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_section | Controls the sort order of these collections against other default collections | `16` | Any number | | `data` | **Description:** Changes the values of the collections<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-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> |
| 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_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:
@ -43,13 +37,10 @@ libraries:
metadata_path: metadata_path:
- pmm: oscars - pmm: oscars
template_variables: template_variables:
collection_section: 9 collection_section: 8
collection_mode: show_items collection_mode: show_items
collection_order: alpha collection_order: alpha
imdb_sort: moviemeter,asc
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
``` ```

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

@ -1,6 +1,6 @@
# Other Awards Default Metadata File # Other Awards Default Metadata File
The `- pmm: other` 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)
@ -13,42 +13,32 @@ The below YAML in your config.yml will create the collections:
libraries: libraries:
Movies: Movies:
metadata_path: metadata_path:
- pmm: other - pmm: other_award
``` ```
## Template Variables ## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Template Variables can be used to manipulate the file from the default settings which are provided.
Below are the available variables which can be used to customize the file. Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
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 |
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | | `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_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_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with template_variables set away from their defaults:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
metadata_path: metadata_path:
- pmm: other - pmm: other_award
template_variables: template_variables:
collection_section: 9 collection_section: 8
collection_mode: show_items collection_mode: show_items
collection_order: alpha collection_order: alpha
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
``` ```

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

@ -18,23 +18,18 @@ libraries:
## Template Variables ## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Template Variables can be used to manipulate the file from the default settings which are provided.
Below are the available variables which can be used to customize the file. Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
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 |
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | | `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_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 | | `data` | **Description:** Changes the values of the collections<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-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> |
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:
@ -44,12 +39,10 @@ libraries:
metadata_path: metadata_path:
- pmm: spirit - pmm: spirit
template_variables: template_variables:
collection_section: 9 collection_section: 8
collection_mode: show_items collection_mode: show_items
collection_order: alpha collection_order: alpha
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
``` ```

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

@ -18,23 +18,18 @@ libraries:
## Template Variables ## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. Template Variables can be used to manipulate the file from the default settings which are provided.
Below are the available variables which can be used to customize the file. Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
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 |
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | | `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_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 | | `data` | **Description:** Changes the values of the collections<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-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> |
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:
@ -44,12 +39,10 @@ libraries:
metadata_path: metadata_path:
- pmm: sundance - pmm: sundance
template_variables: template_variables:
collection_section: 9 collection_section: 8
collection_mode: show_items collection_mode: show_items
collection_order: alpha collection_order: alpha
radarr_add_missing: true radarr_add_missing: true
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
``` ```

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

@ -28,16 +28,21 @@ Note that the `templates_variables:` section only needs to be used if you do NOT
Below are the available variables which can be used to customize the actor file. Below are the available variables which can be used to customize the actor 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 Collection Order<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 0</td></tr><tr><td><code>limit</code></td><td><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> 1</td></tr> |
| 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` | test
| 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 |
| Variable | Usage | Default Value | Values |
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| style | | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme |
| sort_by | Controls the sort method for the collections | `release.desc` | |
| `data` | **Description:** Changes the Collection Order<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 0</td></tr><tr><td><code>ending</code></td><td><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> 1</td></tr><tr><td><code>increment</code></td><td><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 shows an example config.yml with all the template_variables set away from their defaults:

Write Preview
Loading…
Cancel
Save