From 8d7678c8bc703f09d4ba66c81cc8bcf02eb0b913 Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Tue, 18 Oct 2022 16:54:28 -0400 Subject: [PATCH] [133] update resolution collections --- VERSION | 2 +- defaults/award/separator_award.yml | 2 +- defaults/both/content_rating_cs.yml | 17 +--- defaults/both/content_rating_uk.yml | 2 +- defaults/both/resolution.yml | 41 +++++++- defaults/both/resolution_standards.yml | 67 ------------- defaults/chart/anilist.yml | 1 + defaults/chart/basic.yml | 1 + defaults/chart/flixpatrol.yml | 1 + defaults/chart/imdb.yml | 1 + defaults/chart/myanimelist.yml | 1 + defaults/chart/other_chart.yml | 1 + defaults/chart/separator_chart.yml | 2 +- defaults/chart/tautulli.yml | 1 + defaults/chart/tmdb.yml | 1 + defaults/chart/trakt.yml | 1 + defaults/movie/content_rating_us.yml | 2 +- defaults/overlays/audio_codec.yml | 28 +++--- defaults/show/content_rating_us.yml | 2 +- defaults/templates.yml | 5 +- docs/conf.py | 8 +- docs/defaults/award/bafta.md | 1 + docs/defaults/award/cannes.md | 2 +- docs/defaults/award/choice.md | 12 +-- docs/defaults/award/emmy.md | 12 +-- docs/defaults/award/golden.md | 2 +- docs/defaults/award/oscars.md | 2 +- docs/defaults/award/spirit.md | 2 +- docs/defaults/award/sundance.md | 2 +- docs/defaults/both/actor.md | 22 ++--- docs/defaults/both/audio_language.md | 4 +- docs/defaults/both/content_rating_cs.md | 4 +- docs/defaults/both/content_rating_uk.md | 4 +- docs/defaults/both/genre.md | 22 ++--- docs/defaults/both/resolution.md | 54 ++++++++--- docs/defaults/both/resolution_standards.md | 107 --------------------- docs/defaults/both/streaming.md | 22 ++--- docs/defaults/both/studio.md | 30 +++--- docs/defaults/both/subtitle_language.md | 4 +- docs/defaults/chart/anilist.md | 8 +- docs/defaults/chart/basic.md | 8 +- docs/defaults/chart/flixpatrol.md | 20 ++-- docs/defaults/chart/myanimelist.md | 8 +- docs/defaults/chart/other.md | 8 +- docs/defaults/chart/tautulli.md | 10 +- docs/defaults/chart/tmdb.md | 8 +- docs/defaults/chart/trakt.md | 8 +- docs/defaults/files.md | 1 - docs/defaults/movie/decade.md | 18 ++-- docs/defaults/movie/franchise.md | 32 +++--- docs/defaults/movie/producer.md | 26 ++--- docs/defaults/movie/writer.md | 22 ++--- docs/defaults/overlays/audio_codec.md | 2 +- docs/defaults/show/content_rating_us.md | 4 +- docs/defaults/show/country.md | 36 +++---- docs/defaults/show/decade.md | 18 ++-- docs/defaults/show/franchise.md | 34 +++---- modules/meta.py | 18 ++-- modules/overlays.py | 2 +- 59 files changed, 335 insertions(+), 451 deletions(-) delete mode 100644 defaults/both/resolution_standards.yml delete mode 100644 docs/defaults/both/resolution_standards.md diff --git a/VERSION b/VERSION index 10d7ece5..73da5def 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.3-develop132 +1.17.3-develop133 diff --git a/defaults/award/separator_award.yml b/defaults/award/separator_award.yml index 2649949a..a0cdbfb3 100644 --- a/defaults/award/separator_award.yml +++ b/defaults/award/separator_award.yml @@ -8,7 +8,7 @@ external_templates: pmm: templates template_variables: - collection_section: "01" + collection_section: 16 collections: Award Collections: diff --git a/defaults/both/content_rating_cs.yml b/defaults/both/content_rating_cs.yml index 2628912e..f574ed22 100644 --- a/defaults/both/content_rating_cs.yml +++ b/defaults/both/content_rating_cs.yml @@ -41,7 +41,7 @@ dynamic_collections: default: content_rating image: default: content_rating/cs/<> - other: content_rating/other + other: content_rating/cs/NR translation_key: default: content_rating_cs other: content_rating_other @@ -64,8 +64,6 @@ dynamic_collections: - 16 - 17 - 18 - key_name_override: - NR: Not Rated addons: 1: - gb/U @@ -201,15 +199,4 @@ dynamic_collections: - gb/R18 - gb/X - X - - NC-17 - NR: - - Approved - - N/A - - NOT RATED - - Not Rated - - gb/NR - - Unrated - - gb/Not Rated - - gb/Rejected - - gb/Unrated - - None \ No newline at end of file + - NC-17 \ No newline at end of file diff --git a/defaults/both/content_rating_uk.yml b/defaults/both/content_rating_uk.yml index 33c7c911..aaa147ab 100644 --- a/defaults/both/content_rating_uk.yml +++ b/defaults/both/content_rating_uk.yml @@ -41,7 +41,7 @@ dynamic_collections: default: content_rating image: default: content_rating/uk/<> - other: content_rating/other + other: content_rating/uk/NR translation_key: default: content_rating other: content_rating_other diff --git a/defaults/both/resolution.yml b/defaults/both/resolution.yml index 53902adf..23d6e482 100644 --- a/defaults/both/resolution.yml +++ b/defaults/both/resolution.yml @@ -9,6 +9,26 @@ external_templates: pmm: templates template_variables: collection_section: 15 + conditionals: + image: + default: resolution/<> + conditions: + - style: standards + value: resolution/standards/<> + key_name: + conditions: + - style: standards + key: 480 + value: SD + - style: standards + key: 720 + value: HD Ready + - style: standards + key: 1080 + value: Full HD + - style: standards + key: 4k + value: Ultra HD translations: pmm: translations @@ -26,18 +46,35 @@ dynamic_collections: Resolution: type: resolution title_format: <> <>s + other_name: Other Resolutions <>s template: - smart_filter - translation - shared + other_template: + - other_collection + - smart_filter + - translation + - shared template_variables: search_term: default: resolution - image: - default: resolution/<> translation_key: default: resolution + other: resolution_other + order: + 4k: 1_ + 1080: 2_ + 720: 3_ + 480: 4_ + include: + - 4k + - 1080 + - 720 + - 480 addons: + 4k: + - 8k 1080: - 2k 480: diff --git a/defaults/both/resolution_standards.yml b/defaults/both/resolution_standards.yml deleted file mode 100644 index 19e185cc..00000000 --- a/defaults/both/resolution_standards.yml +++ /dev/null @@ -1,67 +0,0 @@ -############################################################################## -# Standard Resolution Collections # -# Created by Yozora, Bullmoose20, & Sohjiro # -# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/resolution_standards.html # -############################################################################## - -external_templates: - pmm: templates - template_variables: - collection_section: 15 - -translations: - pmm: translations - -collections: - Resolution Collections: - template: - - name: separator - separator: resolution - - name: translation - key_name: Resolution - translation_key: separator - -dynamic_collections: - Resolution Standards: - type: resolution - title_format: <> <>s - other_name: Other Resolutions <>s - template: - - smart_filter - - translation - - shared - other_template: - - other_collection - - smart_filter - - translation - - shared - template_variables: - search_term: - default: resolution - image: - default: resolution/standards/<> - translation_key: - default: resolution - other: resolution_other - include: - - SD - - HD Ready - - Full HD - - Ultra HD - addons: - SD: - - 144 - - 240 - - 360 - - 576 - - sd - HD Ready: - - 720 - Full HD: - - 1080 - - 2k - Ultra HD: - - 4k - - 8k - \ No newline at end of file diff --git a/defaults/chart/anilist.yml b/defaults/chart/anilist.yml index 04b0bfb7..8fb9a6c7 100644 --- a/defaults/chart/anilist.yml +++ b/defaults/chart/anilist.yml @@ -9,6 +9,7 @@ external_templates: pmm: templates template_variables: collection_section: "01" + image: chart/<> translations: pmm: translations diff --git a/defaults/chart/basic.yml b/defaults/chart/basic.yml index bac4a04c..a9c7565f 100644 --- a/defaults/chart/basic.yml +++ b/defaults/chart/basic.yml @@ -9,6 +9,7 @@ external_templates: pmm: templates template_variables: collection_section: "01" + image: chart/<> translations: pmm: translations diff --git a/defaults/chart/flixpatrol.yml b/defaults/chart/flixpatrol.yml index 5eac322b..4dcd32e4 100644 --- a/defaults/chart/flixpatrol.yml +++ b/defaults/chart/flixpatrol.yml @@ -10,6 +10,7 @@ external_templates: template_variables: collection_section: "01" pre: "_#" + image: chart/<> translations: pmm: translations diff --git a/defaults/chart/imdb.yml b/defaults/chart/imdb.yml index ef4cb33b..a320692d 100644 --- a/defaults/chart/imdb.yml +++ b/defaults/chart/imdb.yml @@ -9,6 +9,7 @@ external_templates: pmm: templates template_variables: collection_section: "01" + image: chart/<> translations: pmm: translations diff --git a/defaults/chart/myanimelist.yml b/defaults/chart/myanimelist.yml index fecaab17..6659ca67 100644 --- a/defaults/chart/myanimelist.yml +++ b/defaults/chart/myanimelist.yml @@ -9,6 +9,7 @@ external_templates: pmm: templates template_variables: collection_section: "01" + image: chart/<> translations: pmm: translations diff --git a/defaults/chart/other_chart.yml b/defaults/chart/other_chart.yml index f44e515f..7fa2ca76 100644 --- a/defaults/chart/other_chart.yml +++ b/defaults/chart/other_chart.yml @@ -9,6 +9,7 @@ external_templates: pmm: templates template_variables: collection_section: "01" + image: chart/<> translations: pmm: translations diff --git a/defaults/chart/separator_chart.yml b/defaults/chart/separator_chart.yml index 881b4ff8..b249df3b 100644 --- a/defaults/chart/separator_chart.yml +++ b/defaults/chart/separator_chart.yml @@ -8,7 +8,7 @@ external_templates: pmm: templates template_variables: - collection_section: 16 + collection_section: "01" collections: Chart Collections: diff --git a/defaults/chart/tautulli.yml b/defaults/chart/tautulli.yml index e6a83e75..d93843a3 100644 --- a/defaults/chart/tautulli.yml +++ b/defaults/chart/tautulli.yml @@ -9,6 +9,7 @@ external_templates: pmm: templates template_variables: collection_section: "01" + image: chart/<> translations: pmm: translations diff --git a/defaults/chart/tmdb.yml b/defaults/chart/tmdb.yml index 1d954894..4e16f73d 100644 --- a/defaults/chart/tmdb.yml +++ b/defaults/chart/tmdb.yml @@ -9,6 +9,7 @@ external_templates: pmm: templates template_variables: collection_section: "01" + image: chart/<> translations: pmm: translations diff --git a/defaults/chart/trakt.yml b/defaults/chart/trakt.yml index df2495ac..c09cd200 100644 --- a/defaults/chart/trakt.yml +++ b/defaults/chart/trakt.yml @@ -9,6 +9,7 @@ external_templates: pmm: templates template_variables: collection_section: "01" + image: chart/<> translations: pmm: translations diff --git a/defaults/movie/content_rating_us.yml b/defaults/movie/content_rating_us.yml index 6da8f7d9..a4511e36 100644 --- a/defaults/movie/content_rating_us.yml +++ b/defaults/movie/content_rating_us.yml @@ -41,7 +41,7 @@ dynamic_collections: default: content_rating image: default: content_rating/us/<> - other: content_rating/other + other: content_rating/us/NR translation_key: default: content_rating other: content_rating_other diff --git a/defaults/overlays/audio_codec.yml b/defaults/overlays/audio_codec.yml index e50dc90d..aed1b63e 100644 --- a/defaults/overlays/audio_codec.yml +++ b/defaults/overlays/audio_codec.yml @@ -34,33 +34,33 @@ templates: regex: conditions: - key: truehd_atmos - value: '(?i)(?=.*\b(true[ .-]?hd))(?=.*\b(atmos(\b|\d)))' + value: '(?i)^(?=.*\btrue[ ._-]?hd(\b|\d))(?=.*\batmos(\b|\d))' - key: dtsx - value: 'dts[-. ]?x(?!\d)' + value: '(?i)\bdts[ ._-]?x(\b|\d)' - key: plus_atmos - value: '(?i)((?=.*([^-]DD[P+](?!A)|eac3))(?=.*\b(atmos(\b|\d))))|(?=.*\b(DDPA(\b|\d)))' + value: '(?i)^(?=.*\b(dd[p+])|(dolby digital plus)\B)(?=.*\batmos(\b|\d))' - key: dolby_atmos - value: '(?i)^(?!.*([^-]DD[P+](?!A)|eac3|true[ .-]?hd))(?=.*\b(atmos(\b|\d))).*' + value: '(?i)\batmos(\b|\d)' - key: truehd - value: '(?i)^(?!.*(atmos))(?=.*\b(true[ .-]?hd)\b).*' + value: '(?i)\btrue[ ._-]?hd(\b|\d)' - key: ma - value: '(?i)dts[ .-]?(ma\b|hd[ .-]?ma|hd)(?!china|r)' + value: '(?i)\bdts[ ._-]?(ma|hd[ ._-]?ma|hd)' - key: flac - value: '(?i)\bFLAC(\b|\d)' + value: '(?i)\bflac(\b|\d)' - key: pcm - value: '(?i)\b(l?)PCM(\b|\d)' + value: '(?i)\bl?pcm(\b|\d)' - key: hra - value: '(?i)dts[ ._-]?(hd[. ]?)?(hr|hi)' + value: '(?i)\bdts[ ._-]?(hd)?[ ._-]?(hr|hi|hd|ra)' - key: plus - value: '(?i)(?!.*(atmos))(?=.*\b([^-]DD[P+](?!A)|eac3)\b).*' + value: '(?i)\b(dd[p+])|(dolby digital plus)|(e[ ._-]?ac3)\B' - key: dtses - value: '(?i)dts[-. ]?es\b' + value: '(?i)\bdts[ ._-]?es(\b|\d)' - key: dts - value: '(?i)\bDTS(\b|\d)' + value: '(?i)\bdts(\b|\d)' - key: digital - value: '(?i)\bDD[^a-z+]|(?> - other: content_rating/other + other: content_rating/us/NR translation_key: default: content_rating other: content_rating_other diff --git a/defaults/templates.yml b/defaults/templates.yml index a1384216..d3dc3ee2 100644 --- a/defaults/templates.yml +++ b/defaults/templates.yml @@ -20,8 +20,8 @@ templates: sort: <> key: <> pre: "_" - order_<>: "" - image: chart/<> + order: "" + order_<>: <> item_radarr_tag_<>: <> item_sonarr_tag_<>: <> url_poster_<>: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/<>.jpg @@ -35,6 +35,7 @@ templates: - item_radarr_tag - item_sonarr_tag - trakt_list + - image - ignore_ids - ignore_imdb_ids allowed_library_types: diff --git a/docs/conf.py b/docs/conf.py index c628118a..06a01368 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -227,6 +227,7 @@ html_theme_options = { ("_menu", "Movie", "defaults/separators", [ ("Actors", "defaults/both/actor"), ("Audio Languages", "defaults/both/audio_language"), + ("Content Ratings (CS)", "defaults/both/content_rating_cs"), ("Content Ratings (US)", "defaults/movie/content_rating_us"), ("Content Ratings (UK)", "defaults/both/content_rating_uk"), ("Countries", "defaults/movie/country"), @@ -236,7 +237,6 @@ html_theme_options = { ("Genres", "defaults/both/genre"), ("Producers", "defaults/movie/producer"), ("Resolutions", "defaults/both/resolution"), - ("Resolution Standards", "defaults/both/resolution_standards"), ("Seasonal", "defaults/movie/seasonal"), ("Streaming", "defaults/both/streaming"), ("Studios", "defaults/both/studio"), @@ -248,15 +248,15 @@ html_theme_options = { ("_menu", "Show", "defaults/separators", [ ("Actors", "defaults/both/actor"), ("Audio Languages", "defaults/both/audio_language"), - ("Content Ratings (US)", "defaults/show/content_rating_us"), - ("Content Ratings (UK)", "defaults/both/content_rating_uk"), + ("Common Sense Media Content Ratings", "defaults/both/content_rating_cs"), + ("US Content Ratings", "defaults/show/content_rating_us"), + ("UK Content Ratings", "defaults/both/content_rating_uk"), ("Countries", "defaults/show/country"), ("Decades", "defaults/show/decade"), ("Franchises", "defaults/show/franchise"), ("Genres", "defaults/both/genre"), ("Networks", "defaults/show/network"), ("Resolutions", "defaults/both/resolution"), - ("Resolution Standards", "defaults/both/resolution_standards"), ("Streaming", "defaults/both/streaming"), ("Studios", "defaults/both/studio"), ("Subtitle Languages", "defaults/both/subtitle_language"), diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 4efcf778..ebc1503b 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -43,6 +43,7 @@ All [Shared Collection Variables](../variables) are available as well as the add | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. + The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index 83c493dc..7645ac1a 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -36,7 +36,7 @@ All [Shared Collection Variables](../variables) are available as well as the add | Variable | Description & Values | |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `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_<>`1 | **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
| diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index e60a07a5..994d9e23 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -36,13 +36,13 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection 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
| +| 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_<>`1 | **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
| -| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | +| `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
| +| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index 97694548..d6dbd357 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -34,13 +34,13 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection 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
| +| 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_<>`1 | **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
| -| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | +| `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
| +| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index c37b614c..50490172 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -37,7 +37,7 @@ All [Shared Collection Variables](../variables) are available as well as the add | Variable | Description & Values | |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `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_<>`1 | **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
| diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index edd65547..3fb7396c 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -35,7 +35,7 @@ All [Shared Collection Variables](../variables) are available as well as the add | Variable | Description & Values | |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `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_<>`1 | **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
| diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index 76b836b8..67bb8243 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -35,7 +35,7 @@ All [Shared Collection Variables](../variables) are available as well as the add | Variable | Description & Values | |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `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_<>`1 | **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
| diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index bfe5b3c7..a7459109 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -36,7 +36,7 @@ All [Shared Collection Variables](../variables) are available as well as the add | Variable | Description & Values | |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `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_<>`1 | **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
| diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index 3d1336bf..e4edd79c 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -41,19 +41,19 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `style ` | **Description:** Controls the visual theme of the collections created
Values:
bwBlack & White Theme
rainierRainier Theme
| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| Variable | Description & Values | +|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `style ` | **Description:** Controls the visual theme of the collections created.
Values:
bwBlack & White Theme
rainierRainier Theme
| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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 for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `sort_by_<>`1 | **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.
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 these Actors from creating a Dynamic Collection.
**Values:** List of Actor Names | -| `actor_name` | **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. | +| `data` | **Description:** Replaces the `data` dynamic collection value.
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 these Actors from creating a Dynamic Collection.
**Values:** List of Actor Names | +| `actor_name` | **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. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index 0ae10d08..315deeaa 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -41,9 +41,9 @@ All [Shared Collection Variables](../variables) are available as well as the add | `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `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_<>`1 | **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) | +| `sort_by_<>`1 | **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) | | `include` | **Description:** Overrides the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `append_include` | **Description:** Appends to the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index e78a31b3..b2cd89ab 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -45,9 +45,9 @@ All [Shared Collection Variables](../variables) are available as well as the add | `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `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_<>`1 | **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) | +| `sort_by_<>`1 | **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) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index 6cefbfe3..74705257 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -43,9 +43,9 @@ All [Shared Collection Variables](../variables) are available as well as the add | `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `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_<>`1 | **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) | +| `sort_by_<>`1 | **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) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index fa8bd668..ac281d0c 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -37,19 +37,19 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| Variable | Description & Values | +|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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 for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `sort_by_<>`1 | **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) | -| `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.
**Values:** List of Genres found in your library | -| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Genres found in your library | -| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Genres found in your library | -| `genre_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | -| `genre_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the genre <>.`
**Values:** Any string. | +| `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.
**Values:** List of Genres found in your library | +| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Genres found in your library | +| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Genres found in your library | +| `genre_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | +| `genre_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the genre <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index 37aa362f..31ebca33 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -2,7 +2,6 @@ The `resolution` Default Metadata File is used to dynamically create collections based on the resolutions available in your library. -To avoid duplication, this file should not be used in combination with [`resolution_standards`](resolution_standards). **This file works with Movie and Show Libraries.** @@ -15,6 +14,14 @@ To avoid duplication, this file should not be used in combination with [`resolut | `Resolution Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. | | `<> Movies/Shows`
**Example:** `1080p Movies` | `<>`
**Example:** `1080` | Collection of Movies/Shows that have this Resolution. | +#### Standards Style + +Below is a screenshot of the alternative Standards (`standards`) style which can be set via the `style` template variable. + +Standards Style takes the base resolutions ("4K" and "720p") and turns them into the commonly-known standards name ("Ultra HD" and "HD Ready") + +![](../images/resolution_standards.png) + ## Config The below YAML in your config.yml will create the collections: @@ -37,19 +44,26 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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_<>`1 | **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) | -| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.
**Values:** List of Resolutions found in your library | -| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Resolutions found in your library | -| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Resolutions found in your library | -| `resolution_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | -| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the resolution <>.`
**Values:** Any string. | +| Variable | Description & Values | +|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `style ` | **Description:** Controls the visual theme of the collections created.
Values:
defaultDefault Theme
standardsStandards Theme
| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `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_<>`1 | **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) | +| `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** Any Resolutions found in your library | +| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.
**Values:** List of Resolutions found in your library | +| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Resolutions found in your library | +| `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Resolutions found in your library | +| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Resolutions found in your library | +| `resolution_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | +| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the resolution <>.`
**Values:** Any string. | +| `resolution_other_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Other Resolution <>s`
**Values:** Any string with `<>` in it. | +| `resolution_other_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have other uncommon resolutions.`
**Values:** Any string. | + +1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. The below is an example config.yml extract with some Template Variables added in to change how the file works. @@ -66,10 +80,22 @@ libraries: sort_by: title.asc ``` +## Default `include` + +```yaml +include: + - 4k + - 1080 + - 720 + - 480 +``` + ## Default `addons` ```yaml addons: + 4k: + - 8k 1080: - 2k 480: diff --git a/docs/defaults/both/resolution_standards.md b/docs/defaults/both/resolution_standards.md deleted file mode 100644 index 34e4e2d4..00000000 --- a/docs/defaults/both/resolution_standards.md +++ /dev/null @@ -1,107 +0,0 @@ -# Resolution Standards Collections - -The `resolution_standards` Default Metadata File is used to dynamically create collections based on the resolutions available in your library. - -This file takes the base resolutions ("4K" and "720p") and turns them into the commonly-known standards name ("Ultra HD" and "HD Ready") - -To avoid duplication, this file should not be used in combination with [`resolution`](resolution). - -**This file works with Movie and Show Libraries.** - -![](../images/resolution_standards.png) - -## Collections Section 15 - -| Collection | Key | Description | -|:---------------------------------------------------------------|:--------------------------------------:|:----------------------------------------------------------------------------| -| `Resolution Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. | -| `<> Movies/Shows`
**Example:** `Full HD Movies` | `<>`
**Example:** `Full HD` | Collection of Movies/Shows that have this Resolution. | -| `Other Resolution Movies/Shows` | `other` | Collection of Movies/Shows that not a standard Resolution. | - -## Config - -The below YAML in your config.yml will create the collections: - -```yaml -libraries: - Movies: - metadata_path: - - pmm: resolution_standards - TV Shows: - metadata_path: - - pmm: resolution_standards -``` - -## 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. - -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 Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. - -| Variable | Description & Values | -|:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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_<>`1 | **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) | -| `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** Any Resolutions found in your library | -| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.
**Values:** List of Resolutions found in your library | -| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Resolutions found in your library | -| `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Resolutions found in your library | -| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Resolutions found in your library | -| `resolution_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | -| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the resolution <>.`
**Values:** Any string. | -| `resolution_other_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Other Resolution <>s`
**Values:** Any string with `<>` in it. | -| `resolution_other_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have other uncommon resolutions.`
**Values:** Any string. | - -1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. - -The below is an example config.yml extract with some Template Variables added in to change how the file works. - -```yaml -libraries: - Movies: - metadata_path: - - pmm: resolution_standards - template_variables: - use_separator: false - sep_style: stb - use_other: false - exclude: - - HD Ready - sort_by: title.asc -``` - -## Default `include` - -```yaml -include: - - SD - - HD Ready - - Full HD - - Ultra HD -``` - -## Default `addons` - -```yaml -addons: - SD: - - 144 - - 240 - - 360 - - 576 - - sd - HD Ready: - - 720 - Full HD: - - 1080 - - 2k - Ultra HD: - - 4k - - 8k -``` \ No newline at end of file diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index 98900d80..0a22a5d5 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -47,17 +47,17 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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_<>`1 | **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) | -| `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.
**Values:** List of Streaming Service Keys | -| `streaming_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | -| `streaming_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s streaming on <>.`
**Values:** Any string. | +| Variable | Description & Values | +|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `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_<>`1 | **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) | +| `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.
**Values:** List of Streaming Service Keys | +| `streaming_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | +| `streaming_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s streaming on <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index e77eedf7..4b2c8a31 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -37,21 +37,21 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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_<>`1 | **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) | -| `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Studios found in your library | -| `exclude` | **Description:** Exclude these Studios from creating a Dynamic Collection.
**Values:** List of Studios found in your library | -| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Studios found in your library | -| `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Studios found in your library | -| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Studios found in your library | -| `resolution_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | -| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the resolution <>.`
**Values:** Any string. | +| Variable | Description & Values | +|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `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_<>`1 | **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) | +| `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Studios found in your library | +| `exclude` | **Description:** Exclude these Studios from creating a Dynamic Collection.
**Values:** List of Studios found in your library | +| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Studios found in your library | +| `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Studios found in your library | +| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Studios found in your library | +| `resolution_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | +| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the resolution <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index 067d4364..a06309c4 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -41,9 +41,9 @@ All [Shared Collection Variables](../variables) are available as well as the add | `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `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_<>`1 | **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) | +| `sort_by_<>`1 | **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) | | `include` | **Description:** Overrides the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `exclude` | **Description:** Exclude these Subtitle Languages from creating a Dynamic Collection.
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `append_include` | **Description:** Appends to the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md index b6755c8f..3e00d06f 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -37,11 +37,11 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.
**Default:** `100`
**Values:** Number greater then 0 | +| Variable | Description & Values | +|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.
**Default:** `100`
**Values:** Number greater then 0 | | `limit_<>`1 | **Description:** Changes the number of items in a collection of the specified key's collection.
**Default:** `limit`
**Values:** Number greater then 0 | -| `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 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_<>`1 | **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
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index 3b14744f..e3d1ed5e 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -35,11 +35,11 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| Variable | Description & Values | +|:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | | `limit_<>`1 | **Description:** Changes the Smart Filter Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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 for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `sort_by_<>`1 | **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) | | `in_the_last_<>`1 | **Description:** Changes how far back the Smart Filter looks.
**Default:**
`released``90`
`episodes``7`
**Values:** Number Greater then 0 | diff --git a/docs/defaults/chart/flixpatrol.md b/docs/defaults/chart/flixpatrol.md index ea1ca4a3..ae5102db 100644 --- a/docs/defaults/chart/flixpatrol.md +++ b/docs/defaults/chart/flixpatrol.md @@ -39,16 +39,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `location` | **Description:** Changes the Builder Location for all collections in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | -| `location_<>`1 | **Description:** Changes the Builder Location of the specified key's collection.
**Default:** `location`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | -| `time_window` | **Description:** Changes the Builder Time Window for all collections in a Defaults file.
**Default:** `last_week`
**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | -| `time_window_<>`1 | **Description:** Changes the Builder Time Window of the specified key's collection.
**Default:** `time_window`
**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | -| `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_<>`1 | **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
| +| Variable | Description & Values | +|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `location` | **Description:** Changes the Builder Location for all collections in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | +| `location_<>`1 | **Description:** Changes the Builder Location of the specified key's collection.
**Default:** `location`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | +| `time_window` | **Description:** Changes the Builder Time Window for all collections in a Defaults file.
**Default:** `last_week`
**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | +| `time_window_<>`1 | **Description:** Changes the Builder Time Window of the specified key's collection.
**Default:** `time_window`
**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | +| `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_<>`1 | **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
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index de9bfe6d..60a09280 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -38,11 +38,11 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | +| Variable | Description & Values | +|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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 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_<>`1 | **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
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 416e72a2..f9b0ceef 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -37,10 +37,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.
**Default:** `30`
**Values:** Number Greater then 0 | -| `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
| +| Variable | Description & Values | +|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.
**Default:** `30`
**Values:** Number Greater then 0 | +| `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_<>`1 | **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
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 61760637..81e48245 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -37,13 +37,13 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `list_days` | **Description:** Changes the `list_days` attribute of the builder for all collections in a Defaults file.
**Values:** Number greater then 0 | +| Variable | Description & Values | +|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `list_days` | **Description:** Changes the `list_days` attribute of the builder for all collections in a Defaults file.
**Values:** Number greater then 0 | | `list_days_<>`1 | **Description:** Changes the `list_days` attribute of the builder of the specified key's collection.
**Values:** Number greater then 0 | -| `list_size` | **Description:** Changes the `list_size` attribute of the builder for all collections in a Defaults file.
**Values:** Number greater then 0 | +| `list_size` | **Description:** Changes the `list_size` attribute of the builder for all collections in a Defaults file.
**Values:** Number greater then 0 | | `list_size_<>`1 | **Description:** Changes the `list_size` attribute of the builder 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.
**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 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_<>`1 | **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
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index aff079d9..fc8d7881 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -38,11 +38,11 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | +| Variable | Description & Values | +|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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 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_<>`1 | **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
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index ee426b81..ca12a5b4 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -38,11 +38,11 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | +| Variable | Description & Values | +|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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 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_<>`1 | **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
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/files.md b/docs/defaults/files.md index e9935829..5c4f75d0 100644 --- a/docs/defaults/files.md +++ b/docs/defaults/files.md @@ -55,7 +55,6 @@ These collections are applied by calling the below paths into the `metadata_path | [Network](show/network) | `network` | Disney Channel, Lifetime | ❌ | ✅ | | [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | ✅ | ❌ | | [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | ✅ | ✅ | -| [Resolution Standards](both/resolution_standards) | `resolution_standards` | 4K, 1080 OR Ultra HD, Full HD | ✅ | ✅ | | [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | ✅ | ❌ | | [Streaming](both/streaming) | `streaming` | Disney+ Movies, HBO Max Shows | ✅ | ✅ | | [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | ✅ | ✅ | diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index edb1faed..4122a440 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -32,17 +32,17 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | +| Variable | Description & Values | +|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `sort_by_<>`1 | **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) | -| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | -| `decade_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | -| `decade_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Top <> <>s of the <>.`
**Values:** Any string. | +| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | +| `decade_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | +| `decade_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Top <> <>s of the <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 01c1108d..b49c36fe 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -33,32 +33,32 @@ Note that the `templates_variables:` section only needs to be used if you do wan **[Shared Collection Variables](../variables) are NOT available to this default file.** -| Variable | Description & Values | -|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Variable | Description & Values | +|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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:** Adds a sort title with this collection sections.
**Values:** Any number | +| `collection_section` | **Description:** Adds a sort title with this collection sections.
**Values:** Any number | | `order_<>`1 | **Description:** Controls the sort order of the collections in their collection section.
**Values:** Any number | -| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| -| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | +| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| +| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | | `movie_<>`1 | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#default-movie) for that collection if used.
**Values:** List of TMDb Movie IDs | | `name_mapping_<>`1 | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#default-name_mapping) for that collection if used.
**Values:** Any String | -| `sort_title` | **Description:** Sets the sort title for all collections. Use `<>` to use the collection name. **Example:** `"!02_<>"`
**Values:** Any String with `<>` | +| `sort_title` | **Description:** Sets the sort title for all collections. Use `<>` to use the collection name. **Example:** `"!02_<>"`
**Values:** Any String with `<>` | | `sort_title_<>`1 | **Description:** Sets the sort title of the specified key's collection.
**Default:** `sort_title`
**Values:** Any String | -| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.
**Values:** `false` to not build the collection | -| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**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
| +| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.
**Values:** `false` to not build the collection | +| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**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_<>`1 | **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
| -| `title_override` | **Description:** Overrides the [default title_override dictionary](#default-title_override).
**Values:** Dictionary with `key: new_title` entries | -| `exclude` | **Description:** Exclude these TMDb Collections from creating a Dynamic Collection.
**Values:** List of TMDb Collection IDs | -| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of TMDb Collection IDs | -| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of TMDb Collection IDs | -| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | +| `title_override` | **Description:** Overrides the [default title_override dictionary](#default-title_override).
**Values:** Dictionary with `key: new_title` entries | +| `exclude` | **Description:** Exclude these TMDb Collections from creating a Dynamic Collection.
**Values:** List of TMDb Collection IDs | +| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of TMDb Collection IDs | +| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of TMDb Collection IDs | +| `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.
**Default:** `radarr_add_missing`
**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` | **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.
**Default:** `radarr_folder`
**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` | **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.
**Default:** `radarr_tag`
**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` | **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.
**Default:** `item_radarr_tag`
**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. diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index 299543ef..afd25412 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -38,19 +38,19 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `style ` | **Description:** Controls the visual theme of the collections created
Values:
bwBlack & White Theme
rainierRainier Theme
| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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_<>`1 | **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.
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 these Producers from creating a Dynamic Collection.
**Values:** List of Producer Names | -| `producer_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> (Producer)`
**Values:** Any string with `<>` in it. | -| `producer_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s produced by <>.`
**Values:** Any string with `<>` in it. | +| Variable | Description & Values | +|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `style ` | **Description:** Controls the visual theme of the collections created
Values:
bwBlack & White Theme
rainierRainier Theme
| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `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_<>`1 | **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.
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 these Producers from creating a Dynamic Collection.
**Values:** List of Producer Names | +| `producer_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> (Producer)`
**Values:** Any string with `<>` in it. | +| `producer_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s produced by <>.`
**Values:** Any string with `<>` in it. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index cd76f57b..80f0a92f 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -38,19 +38,19 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `style ` | **Description:** Controls the visual theme of the collections created
Values:
bwBlack & White Theme
rainierRainier Theme
| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| Variable | Description & Values | +|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `style ` | **Description:** Controls the visual theme of the collections created
Values:
bwBlack & White Theme
rainierRainier Theme
| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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 for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `sort_by_<>`1 | **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.
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 these Writers from creating a Dynamic Collection.
**Values:** List of Writer Names | -| `writer_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> (Writer)`
**Values:** Any string with `<>` in it. | -| `writer_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s written by <>.`
**Values:** Any string with `<>` in it. | +| `data` | **Description:** Replaces the `data` dynamic collection value.
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 these Writers from creating a Dynamic Collection.
**Values:** List of Writer Names | +| `writer_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> (Writer)`
**Values:** Any string with `<>` in it. | +| `writer_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s written by <>.`
**Values:** Any string with `<>` in it. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/overlays/audio_codec.md b/docs/defaults/overlays/audio_codec.md index 7d2751fc..7c7a8db4 100644 --- a/docs/defaults/overlays/audio_codec.md +++ b/docs/defaults/overlays/audio_codec.md @@ -82,7 +82,7 @@ All [Shared Overlay Variables](variables) are available with the default values 1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. -2. The below is an example config.yml extract with some Template Variables added in to change how the file works. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index f334aeaf..86c9fd02 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -40,9 +40,9 @@ All [Shared Collection Variables](../variables) are available as well as the add | `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `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_<>`1 | **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) | +| `sort_by_<>`1 | **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) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index dd5fc70d..94850eaf 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -39,24 +39,24 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `style ` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `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_<>`1 | **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) | -| `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | -| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | -| `addons` | **Description:** Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | -| `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | -| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).
**Values:** Dictionary with `key: new_key_name` entries | -| `country_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | -| `country_other_name` | **Description:** Changes the Other Collection name.
**Default:** `Other Countries`
**Values:** Any string. | -| `country_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in <>.`
**Values:** Any string. | -| `country_other_summary` | **Description:** Changes the Other Collection summary.
**Default:** `<>s filmed in other uncommon Countries.`
**Values:** Any string. | +| Variable | Description & Values | +|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `style ` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `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_<>`1 | **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) | +| `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | +| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | +| `addons` | **Description:** Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | +| `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | +| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).
**Values:** Dictionary with `key: new_key_name` entries | +| `country_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | +| `country_other_name` | **Description:** Changes the Other Collection name.
**Default:** `Other Countries`
**Values:** Any string. | +| `country_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in <>.`
**Values:** Any string. | +| `country_other_summary` | **Description:** Changes the Other Collection summary.
**Default:** `<>s filmed in other uncommon Countries.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index 05fb7f04..d92590c6 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -32,17 +32,17 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | +| Variable | Description & Values | +|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.
**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `sort_by_<>`1 | **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) | -| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | -| `decade_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | -| `decade_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Top <> <>s of the <>.`
**Values:** Any string. | +| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | +| `decade_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | +| `decade_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Top <> <>s of the <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index 4f1f2337..ee8fda84 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -33,32 +33,32 @@ Note that the `templates_variables:` section only needs to be used if you do wan **[Shared Collection Variables](../variables) are NOT available to this default file.** -| Variable | Description & Values | -|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Variable | Description & Values | +|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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:** Adds a sort title with this collection sections.
**Values:** Any number | +| `collection_section` | **Description:** Adds a sort title with this collection sections.
**Values:** Any number | | `order_<>`1 | **Description:** Controls the sort order of the collections in their collection section.
**Values:** Any number | -| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| -| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | +| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| +| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | | `name_mapping_<>`1 | **Description:** Sets the name mapping value for using assets of the specified key's collection.
**Values:** Any String | -| `sort_title` | **Description:** Sets the sort title for all collections. Use `<>` to use the collection name. **Example:** `"!02_<>"`
**Values:** Any String with `<>` | +| `sort_title` | **Description:** Sets the sort title for all collections. Use `<>` to use the collection name. **Example:** `"!02_<>"`
**Values:** Any String with `<>` | | `sort_title_<>`1 | **Description:** Sets the sort title of the specified key's collection.
**Default:** `sort_title`
**Values:** Any String | -| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these shows sent to Sonarr.
**Values:** `false` to not build the collection | -| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**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
| +| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these shows sent to Sonarr.
**Values:** `false` to not build the collection | +| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**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_<>`1 | **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
| -| `exclude` | **Description:** Exclude these Collections from creating a Dynamic Collection.
**Values:** List of Collection IDs | -| `data` | **Description:** Overrides the [default data dictionary](#default-data). Defines the data that the custom dynamic collection processes.
**Values:** Dictionary List of TMDb Main Show ID | -| `append_data` | **Description:** Appends to the [default data dictionary](#default-data).
**Values:** Dictionary List of TMDb Main Show ID | -| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of TMDb Show IDs | -| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of TMDb Show IDs | -| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | +| `exclude` | **Description:** Exclude these Collections from creating a Dynamic Collection.
**Values:** List of Collection IDs | +| `data` | **Description:** Overrides the [default data dictionary](#default-data). Defines the data that the custom dynamic collection processes.
**Values:** Dictionary List of TMDb Main Show ID | +| `append_data` | **Description:** Appends to the [default data dictionary](#default-data).
**Values:** Dictionary List of TMDb Main Show ID | +| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of TMDb Show IDs | +| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of TMDb Show IDs | +| `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.
**Default:** `sonarr_add_missing`
**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` | **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.
**Default:** `sonarr_folder`
**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` | **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.
**Default:** `sonarr_tag`
**Values:** List or comma-separated string of tags | -| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every show 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` | **Description:** Used to append a tag in Sonarr for every show 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 show found by the builders that's in Sonarr of the specified key's collection.
**Default:** `item_sonarr_tag`
**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. diff --git a/modules/meta.py b/modules/meta.py index 34612560..15a2bf9f 100644 --- a/modules/meta.py +++ b/modules/meta.py @@ -292,7 +292,7 @@ class DataFile: for dkey, dvalue in ini_default.items(): final_key = replace_var(dkey, ini_default) final_value = replace_var(dvalue, ini_default) - if final_key not in optional and final_key not in variables: + if final_key not in optional and final_key not in variables and final_key not in conditionals: default[final_key] = final_value default[f"{final_key}_encoded"] = requests.utils.quote(str(final_value)) @@ -300,7 +300,7 @@ class DataFile: if template["optional"]: for op in util.get_list(template["optional"]): op = replace_var(op, variables) - if op not in default: + if op not in default and op not in conditionals: optional.append(str(op)) optional.append(f"{op}_encoded") else: @@ -317,8 +317,6 @@ class DataFile: final_key = replace_var(con_key, [variables, default]) if final_key != con_key: logger.debug(f"Variable: {final_key}") - if final_key in variables: - continue if "conditions" not in con_value: raise Failed(f"{self.data_type} Error: conditions sub-attribute required for conditionals") conditions = con_value["conditions"] @@ -340,7 +338,7 @@ class DataFile: var_value = replace_var(var_value, [variables, default]) if var_key in variables: if (isinstance(var_value, list) and variables[var_key] not in var_value) or \ - (not isinstance(var_value, list) and variables[var_key] != var_value): + (not isinstance(var_value, list) and str(variables[var_key]) != str(var_value)): if isinstance(var_value, list): logger.debug(f'Condition {i} Failed: {var_key} "{variables[var_key]}" not in {var_value}') else: @@ -349,7 +347,7 @@ class DataFile: break elif var_key in default: if (isinstance(var_value, list) and default[var_key] not in var_value) or \ - (not isinstance(var_value, list) and default[var_key] != var_value): + (not isinstance(var_value, list) and str(default[var_key]) != str(var_value)): if isinstance(var_value, list): logger.debug(f'Condition {i} Failed: {var_key} "{default[var_key]}" not in {var_value}') else: @@ -367,11 +365,11 @@ class DataFile: variables[f"{final_key}_encoded"] = requests.utils.quote(str(condition["value"])) break if not condition_found: - if "default" in con_value: + if "default" in con_value and final_key not in variables: logger.debug(f'Conditional Variable: {final_key} defaults to "{con_value["default"]}"') variables[final_key] = con_value["default"] variables[f"{final_key}_encoded"] = requests.utils.quote(str(con_value["default"])) - else: + elif final_key not in variables: logger.debug(f"Conditional Variable: {final_key} added as optional variable") optional.append(str(final_key)) optional.append(f"{final_key}_encoded") @@ -567,7 +565,7 @@ class MetadataFile(DataFile): include.extend(util.parse("Config", "append_include", self.temp_vars["append_include"], parent="template_variable", datatype="strlist")) addons = util.parse("Config", "addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr") if "addons" in methods else {} if "append_addons" in self.temp_vars: - append_addons = util.parse("Config", "append_addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr") + append_addons = util.parse("Config", "append_addons", self.temp_vars["append_addons"], parent=map_name, methods=methods, datatype="dictliststr") for k, v in append_addons.items(): if k not in addons: addons[k] = [] @@ -766,7 +764,7 @@ class MetadataFile(DataFile): raise Failed(f"Config Error: {map_name} type attribute {dynamic[methods['type']]} invalid") if "append_data" in self.temp_vars: - for k, v in util.parse("Config", "append_data", dynamic, parent=map_name, methods=methods, datatype="strdict").items(): + for k, v in util.parse("Config", "append_data", self.temp_vars["append_data"], parent=map_name, methods=methods, datatype="strdict").items(): all_keys.append(k) if k not in exclude and v not in exclude: auto_list[k] = v diff --git a/modules/overlays.py b/modules/overlays.py index 8b4037a7..b124ef29 100644 --- a/modules/overlays.py +++ b/modules/overlays.py @@ -415,8 +415,8 @@ class Overlays: if item.ratingKey not in properties[builder.overlay.mapping_name].keys: properties[builder.overlay.mapping_name].keys.append(item.ratingKey) if added_titles: - logger.debug(f"{len(added_titles)} Titles Found: {[self.library.get_item_sort_title(a, atr='title') for a in added_titles]}") logger.info(f"{len(added_titles)} Items found for {builder.overlay.mapping_name} Overlay") + logger.trace(f"Titles Found: {[self.library.get_item_sort_title(a, atr='title') for a in added_titles]}") else: logger.warning(f"No Items found for {builder.overlay.mapping_name} Overlay") logger.info("")