mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
[105] update chart doc
This commit is contained in:
meisnate12
parent
615d42972a
commit
d108fe523c
45 changed files with 173 additions and 221 deletions
2
VERSION
2
VERSION
|
|
@ -1 +1 @@
|
|||
1.17.3-develop104
|
||||
1.17.3-develop105
|
||||
|
|
|
|||
|
|
@ -1,63 +1,9 @@
|
|||
#############################################################
|
||||
# AniList Chart Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Movie or Show) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/chart/anilist #
|
||||
# template_variables: #
|
||||
# # Sets the collection mode of the collection #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: "01" #
|
||||
# #
|
||||
# # For each collection use the "key" to set #
|
||||
# # the options. #
|
||||
# # Available collections #
|
||||
# # KEY COLLECTION #
|
||||
# # popular AniList Popular #
|
||||
# # top AniList Top Rated #
|
||||
# # trending AniList Trending #
|
||||
# # season AniList Season #
|
||||
# #
|
||||
# # Available options. Replace "key" with the #
|
||||
# # desired collection's key from the chart above. #
|
||||
# #
|
||||
# # Customize summary of collection #
|
||||
# summary_key: A collection of ... #
|
||||
# # Turn the collection on/off #
|
||||
# use_key: true #
|
||||
# # Determines collection order in it's section #
|
||||
# order_key: #
|
||||
# # Determines collection order of the collection #
|
||||
# collection_order_key: custom #
|
||||
# # Set visible_library for the collection #
|
||||
# visible_library_key: #
|
||||
# # Set visible_home for the collection #
|
||||
# visible_home_key: #
|
||||
# # Set visible_shared for the collection #
|
||||
# visible_shared_key: #
|
||||
# # Set limit for the collection #
|
||||
# limit_key: 100 #
|
||||
# # Adds missing from the collection to radarr #
|
||||
# radarr_add_missing_key: #
|
||||
# # Adds missing from the collection to sonarr #
|
||||
# sonarr_add_missing_key: #
|
||||
# # Radarr Folder to add to #
|
||||
# radarr_folder_key: #
|
||||
# # Sonarr Folder to add to #
|
||||
# sonarr_folder_key: #
|
||||
# # Radarr Tag for added missing #
|
||||
# radarr_tag_key: #
|
||||
# # Sonarr Tag for added missing #
|
||||
# sonarr_tag_key: #
|
||||
# # Radarr Tag for existing items #
|
||||
# item_radarr_tag_key: #
|
||||
# # Sonarr Tag for existing items #
|
||||
# item_sonarr_tag_key: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# AniList Charts Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/chart/anilist.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
|
@ -70,17 +16,20 @@ translations:
|
|||
templates:
|
||||
anilist:
|
||||
default:
|
||||
limit_<<key>>: 100
|
||||
limit: 100
|
||||
limit_<<key>>: <<limit>>
|
||||
chart: <<key>>
|
||||
anilist_<<chart>>: <<limit_<<key>>>>
|
||||
|
||||
season:
|
||||
default:
|
||||
limit_trending: 100
|
||||
limit: 100
|
||||
limit_trending: <<limit>>
|
||||
anilist_search:
|
||||
season: current
|
||||
year:
|
||||
sort_by: popular
|
||||
limit: <<limit_trending>>
|
||||
|
||||
collections:
|
||||
AniList Popular:
|
||||
|
|
|
|||
|
|
@ -125,6 +125,7 @@ html_theme_options = {
|
|||
("Local Walkthrough", "home/guides/local"),
|
||||
("Docker Walkthrough", "home/guides/docker"),
|
||||
("QNAP Walkthrough", "home/guides/qnap"),
|
||||
("Synology Walkthrough", "home/guides/synology"),
|
||||
("unRAID Walkthrough", "home/guides/unraid"),
|
||||
("Kubernetes Walkthrough", "home/guides/kubernetes"),
|
||||
("Docker images", "home/guides/alternative-docker"),
|
||||
|
|
|
|||
|
|
@ -28,19 +28,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `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 | 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 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> |
|
||||
| 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 for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -28,19 +28,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `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 | 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 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> |
|
||||
| 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 for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -30,19 +30,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `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 | 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 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> |
|
||||
| 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 for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -28,19 +28,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `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 | 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 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> |
|
||||
| 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 for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -29,19 +29,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `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 | 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 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> |
|
||||
| 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 for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -26,19 +26,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `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 | 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 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> |
|
||||
| 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 for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -30,15 +30,16 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `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 | Description & Values |
|
||||
|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `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> |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
The below shows an example config.yml with template_variables set away from their defaults:
|
||||
|
||||
|
|
|
|||
|
|
@ -27,19 +27,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `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 | 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 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> |
|
||||
| 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 for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -28,19 +28,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `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 | 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 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> |
|
||||
| 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 for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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> |
|
||||
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_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 is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Genre found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Resolution found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Resolution found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available using the below keys.
|
|||
| paramount | Paramount+ |
|
||||
| peacock | Peacock |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Studio found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_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 is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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> |
|
||||
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -1,63 +1,50 @@
|
|||
# Anilist Chart Default Metadata File
|
||||
|
||||
The `anilist` Metadata File is used to create collections based on Anilist charts
|
||||
The `anilist` Metadata File is used to create collections based on Anilist charts.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
This file works with Movie and TV Libraries.
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: anilist
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: anilist
|
||||
```
|
||||
|
||||
## Collections
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:--------------------|:----------:|:-----------------------------------------------------|
|
||||
| `AniList Popular` | `popular` | Collection of the most Popular Anime on AniList. |
|
||||
| `AniList Top Rated` | `top` | Collection of the Top Rated Anime on AniList. |
|
||||
| `AniList Trending` | `trending` | Collection of the Trending Anime on AniList. |
|
||||
| `AniList Season` | `season` | Collection of the Current Season's Anime on AniList. |
|
||||
|
||||
### Examples
|
||||
|
||||
|
||||
|
||||
## 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 in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one Anilist chart and is used to control multiple template variables.
|
||||
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.
|
||||
|
||||
Below are the keys and what they refer to:
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Key | Anilist Chart |
|
||||
|:----------|:------------------|
|
||||
| popular | AniList Popular |
|
||||
| season | AniList Season |
|
||||
| top | AniList Top Rated |
|
||||
| trending | AniList Trending |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.<br>**Values:** Number greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the number of items in a collection of the specified key's Collection.<br>**Values:** Number greater then 0 |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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> |
|
||||
|
||||
|
||||
|
||||
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_top` instead of `use_key`, `order_popular` instead of `order_key`)
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| 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_popular` to put popular first in the list of anilist charts) |
|
||||
| summary_key | Determines summary of collection | | Any summary text |
|
||||
| limit_key | Determines limit of collection | `100` | Any number |
|
||||
| collection_order | Determines collection order of the collection | | |
|
||||
| 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_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
|
||||
| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` |
|
||||
| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to |
|
||||
| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
|
||||
| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` |
|
||||
| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to |
|
||||
| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
|
||||
| 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 |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
@ -65,21 +52,14 @@ libraries:
|
|||
metadata_path:
|
||||
- pmm: anilist
|
||||
template_variables:
|
||||
use_top: false
|
||||
use_popular: false
|
||||
order_top: 01
|
||||
summary_top: "Top 10 Rated movies on AniList"
|
||||
limit_top: 10
|
||||
visible_library_popular: true
|
||||
visible_home_popular: true
|
||||
visible_shared_popular: true
|
||||
sonarr_add_missing_trending: true
|
||||
sonarr_folder_trending: /mnt/local/Media/TV/
|
||||
sonarr_tag_trending: trending Shows
|
||||
item_sonarr_tag_trending: trending Shows
|
||||
radarr_add_missing_season: true
|
||||
sonarr_folder_season: /mnt/local/Media/TV/Prime Video Shows/
|
||||
sonarr_tag_season: Prime Video Shows
|
||||
item_sonarr_tag_season: Prime Video Shows
|
||||
sonarr_add_missing: true
|
||||
collection_section: 09
|
||||
collection_mode: show_items
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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_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 is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_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 is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_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 is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_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 is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_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 is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_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 is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_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 is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -35,7 +35,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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -35,7 +35,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> |
|
||||
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ Note that the `templates_variables:` section only needs to be used if you do NOT
|
|||
|
||||
All [Shared Variables](../variables) are available
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -35,7 +35,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> |
|
||||
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ Note that the `templates_variables:` section only needs to be used if you do NOT
|
|||
|
||||
All [Shared Variables](../variables) are available
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -35,7 +35,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> |
|
||||
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -35,7 +35,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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ Note that the `templates_variables:` section only needs to be used if you do NOT
|
|||
|
||||
All [Shared Variables](../variables) are available
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -32,7 +32,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_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
The below is an example config.yml extract with some template_variables changed from their defaults.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
|
|||
|
|
@ -6,22 +6,35 @@ Note that the `templates_variables:` section only needs to be used if you do wan
|
|||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:--------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Collections in a Default's file.<br>**Values:** `false` to turn off the collection |
|
||||
| `collection_section` | **Description:** Controls the sort order of the collection sections against other default collection sections.<br>**Values:** Any number |
|
||||
| `order_<<key>>`<sup>1</sup> | **Description:** Controls the sort order of the collections in each collection section.<br>**Values:** Any number |
|
||||
| `collection_mode` | **Description:** Controls the collection mode of these collections.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
||||
| `visible_library_<<key>>`<sup>1</sup> | **Description:** Controls collection visible on Library (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `visible_home_<<key>>`<sup>1</sup> | **Description:** Controls collection visible on Home (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `visible_shared_<<key>>`<sup>1</sup> | **Description:** Controls collection visible on Shared Users' Home (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for these collections<br>**Values:** `true` or `false` |
|
||||
| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for these collections<br>**Values:** Folder Path |
|
||||
| `radarr_tag` | **Description:** Override Radarr `tag` attribute for these collections<br>**Values:** List or comma-separated string of tags |
|
||||
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for these collections<br>**Values:** List or comma-separated string of tags |
|
||||
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for these collections<br>**Values:** `true` or `false` |
|
||||
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for these collections<br>**Values:** Folder Path |
|
||||
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for these collections<br>**Values:** List or comma-separated string of tags |
|
||||
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for these collections<br>**Values:** List or comma-separated string of tags |
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Collections in a Defaults file.<br>**Values:** `false` to turn off the collection |
|
||||
| `name_<<key>>`<sup>1</sup> | **Description:** Changes the name of the specified key's Collection.<br>**Values:** New Collection Name |
|
||||
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the specified key's Collection.<br>**Values:** New Collection Summary |
|
||||
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number |
|
||||
| `order_<<key>>`<sup>1</sup> | **Description:** Controls the sort order of the collections in each collection section.<br>**Values:** Any number |
|
||||
| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
||||
| `visible_library` | **Description:** Controls visible on Library for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `visible_library_<<key>>`<sup>1</sup> | **Description:** Controls visible on Library of the specified key's Collection. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `visible_home` | **Description:** Controls visible on Home for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `visible_home_<<key>>`<sup>1</sup> | **Description:** Controls visible on Home of the specified key's Collection. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `visible_shared` | **Description:** Controls visible on Shared Users' Home for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `visible_shared_<<key>>`<sup>1</sup> | **Description:** Controls visible on Shared Users' Home of the specified key's Collection. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||
| `radarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `add_missing` attribute of the specified key's Collection.<br>**Values:** `true` or `false` |
|
||||
| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
||||
| `radarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Radarr `root_folder_path` attribute of the specified key's Collection.<br>**Values:** Folder Path |
|
||||
| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||
| `radarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Radarr `tag` attribute of the specified key's Collection.<br>**Values:** List or comma-separated string of tags |
|
||||
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||
| `item_radarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's Collection.<br>**Values:** List or comma-separated string of tags |
|
||||
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
||||
| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the specified key's Collection.<br>**Values:** `true` or `false` |
|
||||
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
||||
| `sonarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's Collection.<br>**Values:** Folder Path |
|
||||
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||
| `sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `tag` attribute of the specified key's Collection.<br>**Values:** List or comma-separated string of tags |
|
||||
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's Collection.<br>**Values:** List or comma-separated string of tags |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
Loading…
Reference in a new issue