diff --git a/VERSION b/VERSION index fcfd6bdd..a31d4e50 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.3-develop106 +1.17.3-develop107 diff --git a/defaults/both/actor.yml b/defaults/both/actor.yml index f34db23e..9ec770c8 100644 --- a/defaults/both/actor.yml +++ b/defaults/both/actor.yml @@ -1,31 +1,9 @@ -############################################################# -# Actor 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/actor # -# template_variables: # -# # Sets the style of posters: bw or rainier # -# style: bw # -# # Turn the separator collection on/off # -# use_separator: true # -# # Separator style (red, blue, green, gray, # -# purple, stb, orig) # -# sep_style: orig # -# # Sets how the collection is sorted # -# sort_by: release.desc # -# # Sets the collection mode of the collections # -# collection_mode: # -# # Sets the value at the start of the sort title # -# collection_section: 17 # -# # Radarr Tag for existing items # -# item_radarr_tag: # -# # Sonarr Tag for existing items # -# item_sonarr_tag: # -############################################################# +############################################################################## +# Actor Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/both/actor.html # +############################################################################## external_templates: pmm: templates diff --git a/defaults/templates.yml b/defaults/templates.yml index f919c03d..b7baed8a 100644 --- a/defaults/templates.yml +++ b/defaults/templates.yml @@ -13,19 +13,6 @@ templates: blank_collection: true url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/separators/<>/<>.jpg - separator off: - default: - sep_style: orig - collection_section: "00" - use_separator: false - optional: - - collection_mode - allowed_library_types: <> - collection_mode: <> - sort_title: "!<>_!<>" - blank_collection: true - url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/separators/<>/<>.jpg - shared: default: collection_section: "00" diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index da004188..f474450a 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -4,16 +4,9 @@ The `bafta` Metadata File is used to create collections based on the British Aca This Default file requires [Trakt Authentication](../../config/trakt) -This file only works with Movie Libraries. +**This file only works with Movie Libraries.** -The below YAML in your config.yml will create the collections: - -```yaml -libraries: - Movies: - metadata_path: - - pmm: bafta -``` +![](../images/bafta.png) ## Collections @@ -22,9 +15,16 @@ libraries: | `BAFTA Best Films` | `best` | Collection of British Academy of Film and Television Arts Best Film Award Winners. | | `BAFTA <>` | `<>` | Collection of British Academy of Film and Television Arts Award Winners for the given year. | -### Examples +## Config -![](../images/bafta.png) +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: bafta +``` ## Template Variables @@ -34,12 +34,12 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| 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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • 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 added in to change how the file works. @@ -49,8 +49,10 @@ libraries: metadata_path: - pmm: bafta template_variables: - collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true + data: + starting: current_year-10 + ending: current_year ``` diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index 49831d41..0ed4b551 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -4,16 +4,9 @@ The `cannes` Metadata File is used to create collections based on the Cannes Fil This Default file requires [Trakt Authentication](../../config/trakt) -This file only works with Movie Libraries. +**This file only works with Movie Libraries.** -The below YAML in your config.yml will create the collections: - -```yaml -libraries: - Movies: - metadata_path: - - pmm: cannes -``` +![](../images/cannes.png) ## Collections @@ -22,9 +15,16 @@ libraries: | `Cannes Golden Palm Winners` | `palm` | Collection of Cannes Golden Palm Award Winners. | | `Cannes <>` | `<>` | Collection of Cannes Film Award Winners for the given year. | -### Examples +## Config -![](../images/cannes.png) +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: cannes +``` ## Template Variables @@ -34,12 +34,12 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| 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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • 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 added in to change how the file works. @@ -49,8 +49,10 @@ libraries: metadata_path: - pmm: cannes template_variables: - collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true + data: + starting: current_year-10 + ending: current_year ``` diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index 5a375a92..28843227 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -36,12 +36,12 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| 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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • 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 added in to change how the file works. @@ -51,10 +51,12 @@ libraries: metadata_path: - pmm: choice template_variables: - collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true + data: + starting: current_year-10 + ending: current_year ``` diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index 7815196e..72d8e0b8 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -34,12 +34,12 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| 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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • 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 added in to change how the file works. @@ -49,10 +49,12 @@ libraries: metadata_path: - pmm: emmy template_variables: - collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true + data: + starting: current_year-10 + ending: current_year ``` diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index b45d91da..be5451cf 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -35,12 +35,12 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| 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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • 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 added in to change how the file works. @@ -50,10 +50,12 @@ libraries: metadata_path: - pmm: golden template_variables: - collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true + data: + starting: current_year-10 + ending: current_year ``` diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index 194f7ea1..27b4c3ff 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -33,12 +33,12 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| 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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • 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 added in to change how the file works. @@ -48,10 +48,12 @@ libraries: metadata_path: - pmm: oscars template_variables: - collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true + data: + starting: current_year-10 + ending: current_year ``` diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md index 808ae500..d081118c 100644 --- a/docs/defaults/award/other.md +++ b/docs/defaults/award/other.md @@ -49,7 +49,6 @@ libraries: metadata_path: - pmm: other_award template_variables: - collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index fda37ea9..a0997a85 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -33,12 +33,12 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| 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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • 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 added in to change how the file works. @@ -48,10 +48,12 @@ libraries: metadata_path: - pmm: spirit template_variables: - collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true + data: + starting: current_year-10 + ending: current_year ``` diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index 9507210f..edebc746 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -34,12 +34,12 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| 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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/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.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/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.
**Default:** `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](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • 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 added in to change how the file works. @@ -49,10 +49,12 @@ libraries: metadata_path: - pmm: sundance template_variables: - collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true + data: + starting: current_year-10 + ending: current_year ``` diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index 512e932e..d9448f24 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -2,45 +2,55 @@ The `actor` Metadata File is used to dynamically create collections based on the most popular actors/actresses in your library. -This file works with Movie and TV Libraries. +**This file works with Movie and TV Libraries.** + +![](../images/actor1.png) + +## Collections Section 17 + +| Collection | Key | Description | +|:---------------------|:----------------:|:-----------------------------------------------------------| +| `Actors Collections` | `separator` | Separator Collection to denote the Section of Collections. | +| `<>` | `<>` | Collection of Movies/Shows the actor is top billing in. | + +#### Rainier Style + +Below is a screenshot of the alternative Rainier (`rainier`) style which can be set via the `style` template variable. + +![](../images/actor2.png) + +## Config The below YAML in your config.yml will create the collections: + ```yaml libraries: Movies: metadata_path: - pmm: actor + TV Shows: + metadata_path: + - pmm: actor ``` -## Collections - -| Collection | Key | Description | -|:-----------|:----------:|:------------------------------------------------------| -| `<>` | `<>` | Collection of Emmys Award Winners for the given year. | - -Example Collections Created: - -![](../images/actor1.png) - -## Rainier Style -Below is a screenshot of the alternative `Rainier` style which can be set via template variables - -![](../images/actor2.png) - ## Template Variables -Template Variables can be used to manipulate the actor file from the default settings which are provided. -Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy. -All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. +Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's 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 | -|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `style ` | **Description:** Controls the visual theme of the collections created
**Values:**`bw` - Black and white theme or
`rainier` - Rainier theme | -| `sort_by` | **Description:** Controls the sort method for the collections
**Values:** Any sort method in the [Sorts Options Table](#sort-options) | -| `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
| - +| Variable | Description & Values | +|:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | +| `style ` | **Description:** Controls the visual theme of the collections created
**Values:**
Values:
bwBlack & White Theme
rainierRainier Theme
| +| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `data` | **Description:** Replaces the `data` dynamic collection value.
**Values:**
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Default: 5
Values: Number greater than 0
limitControls the maximum number of collections to create
Default: 25
Values: Number greater than 0
| +| `exclude` | **Description:** Exclude Actors from creating a Dynamic Collection.
**Values:** List of Actor Names. | +| `title_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | +| `actor_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s with <>.`
**Values:** Any string with `<>` in it. | The below is an example config.yml extract with some Template Variables added in to change how the file works. @@ -55,8 +65,6 @@ libraries: limit: 20 style: rainier sort_by: title.asc - collection_section: 12 - collection_mode: show_items use_separator: false sep_style: purple ``` diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index 6d8a34b9..739aec0d 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -2,33 +2,51 @@ The `audio_language` Metadata File is used to dynamically create collections based on the audio languages available in your library. -Example Collections Created: +**This file works with Movie and TV Libraries.** ![](../images/audio_language.png) +## Collections Section 10 + +| Collection | Key | Description | +|:-----------------------------|:--------------------:|:-----------------------------------------------------------| +| `Audio Language Collections` | `separator` | Separator Collection to denote the Section of Collections. | +| `<