From d108fe523c0f2dbd6cfc267f29bd8a95b305574c Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Fri, 7 Oct 2022 16:56:11 -0400 Subject: [PATCH] [105] update chart doc --- VERSION | 2 +- defaults/chart/anilist.yml | 73 ++++----------------- docs/conf.py | 1 + docs/defaults/award/bafta.md | 15 +++-- docs/defaults/award/cannes.md | 15 +++-- docs/defaults/award/choice.md | 15 +++-- docs/defaults/award/emmy.md | 15 +++-- docs/defaults/award/golden.md | 15 +++-- docs/defaults/award/oscars.md | 15 +++-- docs/defaults/award/other.md | 9 +-- docs/defaults/award/spirit.md | 15 +++-- docs/defaults/award/sundance.md | 15 +++-- docs/defaults/both/actor.md | 2 +- docs/defaults/both/audio_language.md | 2 +- docs/defaults/both/content_rating_cs.md | 2 +- docs/defaults/both/content_rating_uk.md | 2 +- docs/defaults/both/genre.md | 2 +- docs/defaults/both/resolution.md | 2 +- docs/defaults/both/resolution_standards.md | 2 +- docs/defaults/both/streaming.md | 2 +- docs/defaults/both/studio.md | 2 +- docs/defaults/both/subtitle_language.md | 2 +- docs/defaults/both/year.md | 2 +- docs/defaults/chart/anilist.md | 76 ++++++++-------------- docs/defaults/chart/basic.md | 2 +- docs/defaults/chart/imdb.md | 2 +- docs/defaults/chart/myanimelist.md | 2 +- docs/defaults/chart/other.md | 2 +- docs/defaults/chart/tautulli.md | 2 +- docs/defaults/chart/tmdb.md | 2 +- docs/defaults/chart/trakt.md | 2 +- docs/defaults/movie/content_rating_us.md | 2 +- docs/defaults/movie/country.md | 2 +- docs/defaults/movie/decade.md | 2 +- docs/defaults/movie/director.md | 2 +- docs/defaults/movie/franchise.md | 2 +- docs/defaults/movie/producer.md | 2 +- docs/defaults/movie/universe.md | 2 +- docs/defaults/movie/writer.md | 2 +- docs/defaults/show/content_rating_us.md | 2 +- docs/defaults/show/country.md | 2 +- docs/defaults/show/decade.md | 2 +- docs/defaults/show/franchise.md | 2 +- docs/defaults/show/network.md | 2 +- docs/defaults/variables.md | 47 ++++++++----- 45 files changed, 171 insertions(+), 219 deletions(-) diff --git a/VERSION b/VERSION index 041f2e9f..2ee949f6 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.3-develop104 +1.17.3-develop105 diff --git a/defaults/chart/anilist.yml b/defaults/chart/anilist.yml index 9acfe27b..04b0bfb7 100644 --- a/defaults/chart/anilist.yml +++ b/defaults/chart/anilist.yml @@ -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_<>: 100 + limit: 100 + limit_<>: <> chart: <> anilist_<>: <>>> season: default: - limit_trending: 100 + limit: 100 + limit_trending: <> anilist_search: season: current year: sort_by: popular + limit: <> collections: AniList Popular: diff --git a/docs/conf.py b/docs/conf.py index 7c5dbd47..a89daed7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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"), diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 9cddf879..15267ec1 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -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
**Values:** `false` to turn of the collections | -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| +| Variable | Description & Values | +|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off.
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -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: diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index c3bafe2b..fc3e0441 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -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
**Values:** `false` to turn of the collections | -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| +| Variable | Description & Values | +|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -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: diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index db428ee4..c024f94f 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -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
**Values:** `false` to turn of the collections | -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| +| Variable | Description & Values | +|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -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: diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index 9b3b8912..a0fcdf9a 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -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
**Values:** `false` to turn of the collections | -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| +| Variable | Description & Values | +|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -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: diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index b6bdad5d..6d05fe37 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -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
**Values:** `false` to turn of the collections | -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| +| Variable | Description & Values | +|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -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: diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index e30138f2..61612644 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -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
**Values:** `false` to turn of the collections | -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| +| Variable | Description & Values | +|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -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: diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md index 7b9529d5..defbc1b8 100644 --- a/docs/defaults/award/other.md +++ b/docs/defaults/award/other.md @@ -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
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| Variable | Description & Values | +|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below shows an example config.yml with template_variables set away from their defaults: diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index cff50775..39cecabb 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -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
**Values:** `false` to turn of the collections | -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| +| Variable | Description & Values | +|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -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: diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index bcb7b670..0bb64091 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -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
**Values:** `false` to turn of the collections | -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| +| Variable | Description & Values | +|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -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: diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index 27684c44..5f3d7644 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -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
**Values:**
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Values: Number greater than 0		Default: 5
limitControls the maximum number of collections to create
Values: Number greater than 0		Default: 25
| -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: diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index 811b500a..dbad0ca7 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -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
**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
**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: diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index eab99381..5fa65573 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -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
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index 73e0362d..7409ec87 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -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
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index 454f0c7a..0bead311 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -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
**Values:** Any Genre found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index 8de65aab..5c0d3862 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -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
**Values:** Any Resolution found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/both/resolution_standards.md b/docs/defaults/both/resolution_standards.md index a760c90a..2f86bf59 100644 --- a/docs/defaults/both/resolution_standards.md +++ b/docs/defaults/both/resolution_standards.md @@ -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
**Values:** Any Resolution found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index 27773b12..a8cbda37 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -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: diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index 20f986bd..fc54b132 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -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
**Values:** Any Studio found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index 3a0637e1..38b4b098 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -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
**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
**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: diff --git a/docs/defaults/both/year.md b/docs/defaults/both/year.md index 401e173b..31c35169 100644 --- a/docs/defaults/both/year.md +++ b/docs/defaults/both/year.md @@ -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
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-10
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -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: diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md index 7b8c38ff..93fbd9e8 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -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: - -![](../images/anilist.png) +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 -## 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. - -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. +| 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. | -Below are the keys and what they refer to: +### Examples -| Key | Anilist Chart | -|:----------|:------------------| -| popular | AniList Popular | -| season | AniList Season | -| top | AniList Top Rated | -| trending | AniList Trending | +![](../images/anilist.png) +## Template Variables +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy. -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`) +Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored. +All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Usage | Default Value | Values | -|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| 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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | +| Variable | Description & Values | +|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.
**Values:** Number greater then 0 | +| `limit_<>` | **Description:** Changes the number of items in a collection of the specified key's Collection.
**Values:** Number greater then 0 | +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -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 ``` diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index 0079b8c7..e4665cb7 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index 749a877f..f701096d 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index b78a7ff9..946a388e 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 26ef47b5..1ef02a8b 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 4d8b47d0..500661d2 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index 855d87f3..1fe34c6f 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index 6d2e9d19..010c9cca 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index 9be78104..e3a91fea 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -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
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index 66666627..e7c66d77 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -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
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index d3719a5f..61c8bb64 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -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
**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 diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index 956ed6ea..e253c120 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -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
**Values:**
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Values: Number greater than 0		Default: 5
limitControls the maximum number of collections to create
Values: Number greater than 0		Default: 25
| -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: diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index ba88579e..3ec0a9a8 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -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: diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index cf1a493c..eda442d3 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -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
**Values:**
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Values: Number greater than 0		Default: 5
limitControls the maximum number of collections to create
Values: Number greater than 0		Default: 25
| -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: diff --git a/docs/defaults/movie/universe.md b/docs/defaults/movie/universe.md index 1e0e776a..ec9a6995 100644 --- a/docs/defaults/movie/universe.md +++ b/docs/defaults/movie/universe.md @@ -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 diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index 9daa940f..7bee6be3 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -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
**Values:**
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Values: Number greater than 0		Default: 5
limitControls the maximum number of collections to create
Values: Number greater than 0		Default: 25
| -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: diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index d3f34711..1ee19dfb 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -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
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index 2543f0b7..041cb3a8 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -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
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index bc71baf3..5bacc0f1 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -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
**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: diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index a89c21fd..4c9ed45b 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -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: diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index 3b5c6faa..e1692357 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -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
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**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: diff --git a/docs/defaults/variables.md b/docs/defaults/variables.md index 5c790db0..0c8057c3 100644 --- a/docs/defaults/variables.md +++ b/docs/defaults/variables.md @@ -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_<>`1 | **Description:** Turns off individual Collections in a Default's file.
**Values:** `false` to turn off the collection | -| `collection_section` | **Description:** Controls the sort order of the collection sections against other default collection sections.
**Values:** Any number | -| `order_<>`1 | **Description:** Controls the sort order of the collections in each collection section.
**Values:** Any number | -| `collection_mode` | **Description:** Controls the collection mode of these collections.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| -| `visible_library_<>`1 | **Description:** Controls collection visible on Library (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `visible_home_<>`1 | **Description:** Controls collection visible on Home (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `visible_shared_<>`1 | **Description:** Controls collection visible on Shared Users' Home (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for these collections
**Values:** `true` or `false` | -| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for these collections
**Values:** Folder Path | -| `radarr_tag` | **Description:** Override Radarr `tag` attribute for these collections
**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
**Values:** List or comma-separated string of tags | -| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for these collections
**Values:** `true` or `false` | -| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for these collections
**Values:** Folder Path | -| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for these collections
**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
**Values:** List or comma-separated string of tags | +| Variable | Description & Values | +|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_<>`1 | **Description:** Turns off individual Collections in a Defaults file.
**Values:** `false` to turn off the collection | +| `name_<>`1 | **Description:** Changes the name of the specified key's Collection.
**Values:** New Collection Name | +| `summary_<>`1 | **Description:** Changes the summary of the specified key's Collection.
**Values:** New Collection Summary | +| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.
**Values:** Any number | +| `order_<>`1 | **Description:** Controls the sort order of the collections in each collection section.
**Values:** Any number | +| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| +| `visible_library` | **Description:** Controls visible on Library for all collections in a Defaults file. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_library_<>`1 | **Description:** Controls visible on Library of the specified key's Collection. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_home` | **Description:** Controls visible on Home for all collections in a Defaults file. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_home_<>`1 | **Description:** Controls visible on Home of the specified key's Collection. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_shared` | **Description:** Controls visible on Shared Users' Home for all collections in a Defaults file. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_shared_<>`1 | **Description:** Controls visible on Shared Users' Home of the specified key's Collection. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | +| `radarr_add_missing_<>`1 | **Description:** Override Radarr `add_missing` attribute of the specified key's Collection.
**Values:** `true` or `false` | +| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.
**Values:** Folder Path | +| `radarr_folder_<>`1 | **Description:** Override Radarr `root_folder_path` attribute of the specified key's Collection.
**Values:** Folder Path | +| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | +| `radarr_tag_<>`1 | **Description:** Override Radarr `tag` attribute of the specified key's Collection.
**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.
**Values:** List or comma-separated string of tags | +| `item_radarr_tag_<>`1 | **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.
**Values:** List or comma-separated string of tags | +| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | +| `sonarr_add_missing_<>`1 | **Description:** Override Sonarr `add_missing` attribute of the specified key's Collection.
**Values:** `true` or `false` | +| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.
**Values:** Folder Path | +| `sonarr_folder_<>`1 | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's Collection.
**Values:** Folder Path | +| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | +| `sonarr_tag_<>`1 | **Description:** Override Sonarr `tag` attribute of the specified key's Collection.
**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.
**Values:** List or comma-separated string of tags | +| `item_sonarr_tag_<>`1 | **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.
**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 `<>` with when calling. \ No newline at end of file