From 1a1d985fb992545c3cd166798b95f5dddc19b1f8 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Wed, 29 Nov 2023 15:23:04 +0000 Subject: [PATCH] use markdown-include to include shared variables on each Defaults page rather than linking to the third page --- docs/defaults/award/bafta.md | 10 +-- docs/defaults/award/cannes.md | 10 +-- docs/defaults/award/choice.md | 10 +-- docs/defaults/award/emmy.md | 10 +-- docs/defaults/award/golden.md | 10 +-- docs/defaults/award/oscars.md | 10 +-- docs/defaults/award/other.md | 10 +-- docs/defaults/award/spirit.md | 10 ++- docs/defaults/award/sundance.md | 10 +-- docs/defaults/both/actor.md | 10 +-- docs/defaults/both/aspect.md | 10 +-- docs/defaults/both/audio_language.md | 10 +-- docs/defaults/both/based.md | 6 +- docs/defaults/both/content_rating_cs.md | 10 +-- docs/defaults/both/content_rating_mal.md | 6 +- docs/defaults/both/content_rating_uk.md | 10 +-- docs/defaults/both/genre.md | 10 +-- docs/defaults/both/resolution.md | 10 +-- docs/defaults/both/streaming.md | 10 +-- docs/defaults/both/studio.md | 10 +-- docs/defaults/both/subtitle_language.md | 10 +-- docs/defaults/both/universe.md | 10 +-- docs/defaults/both/year.md | 10 +-- docs/defaults/chart/anilist.md | 9 ++- docs/defaults/chart/basic.md | 9 ++- docs/defaults/chart/flixpatrol.md | 9 ++- docs/defaults/chart/imdb.md | 9 ++- docs/defaults/chart/myanimelist.md | 9 ++- docs/defaults/chart/other.md | 9 ++- docs/defaults/chart/tautulli.md | 9 ++- docs/defaults/chart/tmdb.md | 9 ++- docs/defaults/chart/trakt.md | 9 ++- docs/defaults/collection_variables.md | 14 +--- docs/defaults/files.md | 6 +- docs/defaults/movie/content_rating_us.md | 9 ++- docs/defaults/movie/continent.md | 9 ++- docs/defaults/movie/country.md | 9 ++- docs/defaults/movie/decade.md | 9 ++- docs/defaults/movie/director.md | 9 ++- docs/defaults/movie/franchise.md | 3 + docs/defaults/movie/producer.md | 9 ++- docs/defaults/movie/region.md | 9 ++- docs/defaults/movie/seasonal.md | 9 ++- docs/defaults/movie/writer.md | 12 ++-- docs/defaults/overlay_text_variables.md | 18 +++++ docs/defaults/overlay_variables.md | 44 +----------- docs/defaults/overlays/aspect.md | 39 ++++++----- docs/defaults/overlays/audio_codec.md | 33 +++++---- docs/defaults/overlays/commonsense.md | 45 ++++++------ docs/defaults/overlays/content_rating_uk.md | 14 ++-- .../overlays/content_rating_us_movie.md | 39 +++++------ .../overlays/content_rating_us_show.md | 39 +++++------ docs/defaults/overlays/direct_play.md | 35 +++++----- docs/defaults/overlays/episode_info.md | 32 +++++---- docs/defaults/overlays/flixpatrol.md | 70 +++++++++++-------- docs/defaults/overlays/language_count.md | 43 ++++++------ docs/defaults/overlays/languages.md | 43 ++++++------ docs/defaults/overlays/mediastinger.md | 28 ++++---- docs/defaults/overlays/network.md | 28 ++++---- docs/defaults/overlays/ratings.md | 41 ++++++----- docs/defaults/overlays/resolution.md | 33 +++++---- docs/defaults/overlays/ribbon.md | 24 ++++--- docs/defaults/overlays/runtimes.md | 35 +++++----- docs/defaults/overlays/status.md | 37 +++++----- docs/defaults/overlays/streaming.md | 12 ++-- docs/defaults/overlays/studio.md | 34 +++++---- docs/defaults/overlays/versions.md | 33 +++++---- docs/defaults/overlays/video_format.md | 37 +++++----- docs/defaults/show/content_rating_us.md | 9 ++- docs/defaults/show/continent.md | 9 ++- docs/defaults/show/country.md | 9 ++- docs/defaults/show/decade.md | 12 ++-- docs/defaults/show/franchise.md | 3 + docs/defaults/show/network.md | 9 ++- docs/defaults/show/region.md | 9 ++- 75 files changed, 649 insertions(+), 657 deletions(-) create mode 100644 docs/defaults/overlay_text_variables.md diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index f6d6c4fb..3e4ed8c4 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -28,14 +28,10 @@ libraries: - pmm: bafta ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 | @@ -51,6 +47,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index 210f0bb4..f75397da 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -28,14 +28,10 @@ libraries: - pmm: cannes ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 | @@ -51,6 +47,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index e939d755..9a2b7cc5 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -30,14 +30,10 @@ libraries: - pmm: choice ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 | @@ -53,6 +49,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index 8865814e..cc72892d 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -28,14 +28,10 @@ libraries: - pmm: emmy ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 off the collections | @@ -51,6 +47,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index 18726c6b..9e580393 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -32,14 +32,10 @@ libraries: - pmm: golden ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 | @@ -55,6 +51,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index d2a9189f..5b32784f 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -27,14 +27,10 @@ libraries: - pmm: oscars ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 | @@ -50,6 +46,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md index d25aa54d..59d4fc27 100644 --- a/docs/defaults/award/other.md +++ b/docs/defaults/award/other.md @@ -30,14 +30,10 @@ libraries: - pmm: other_award ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - | Variable | Description & Values | |:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.
**Default:** `sync`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| @@ -47,6 +43,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index bab393c8..d1a549cb 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -27,14 +27,10 @@ libraries: - pmm: spirit ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 | @@ -50,7 +46,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 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. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index 98cdb1b3..7882d5de 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -28,14 +28,10 @@ libraries: - pmm: sundance ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 | @@ -51,6 +47,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index 84a79907..b28c79d5 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -31,14 +31,10 @@ libraries: - pmm: actor ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -58,6 +54,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/aspect.md b/docs/defaults/both/aspect.md index b4a5a2e2..3d389b45 100644 --- a/docs/defaults/both/aspect.md +++ b/docs/defaults/both/aspect.md @@ -36,14 +36,10 @@ libraries: - pmm: aspect ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -60,6 +56,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index b345d390..ab9b62fc 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -30,14 +30,10 @@ libraries: - pmm: audio_language ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -55,6 +51,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/based.md b/docs/defaults/both/based.md index c0725c8f..06af8163 100644 --- a/docs/defaults/both/based.md +++ b/docs/defaults/both/based.md @@ -32,14 +32,10 @@ libraries: - pmm: based ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index d247f9b8..3a78cf4c 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -34,14 +34,10 @@ libraries: - pmm: content_rating_cs ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -62,6 +58,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/content_rating_mal.md b/docs/defaults/both/content_rating_mal.md index 90e23c74..4e9b4c14 100644 --- a/docs/defaults/both/content_rating_mal.md +++ b/docs/defaults/both/content_rating_mal.md @@ -34,14 +34,10 @@ libraries: - pmm: content_rating_mal ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index eb3cb622..157d1250 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -34,14 +34,10 @@ libraries: - pmm: content_rating_uk ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -62,6 +58,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index 7d15d906..630b90bd 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -31,14 +31,10 @@ libraries: - pmm: genre ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -56,6 +52,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index bcfaac5b..f34ce75c 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -37,14 +37,10 @@ libraries: - pmm: resolution ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -66,6 +62,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index c44311cc..7c3dc174 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -45,14 +45,10 @@ libraries: - pmm: streaming ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -71,6 +67,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ## Regional Variants Some logic is applied to allow for regional streaming service lists to be available to users depending on where they are, as detailed below: diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index 9a98b59d..2d2ce103 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -31,14 +31,10 @@ libraries: - pmm: studio ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -59,6 +55,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index cf25036c..40ce6118 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -30,14 +30,10 @@ libraries: - pmm: subtitle_language ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -55,6 +51,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/universe.md b/docs/defaults/both/universe.md index fbcb9d40..4eacbcf2 100644 --- a/docs/defaults/both/universe.md +++ b/docs/defaults/both/universe.md @@ -43,14 +43,10 @@ libraries: - pmm: universe ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -70,6 +66,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/both/year.md b/docs/defaults/both/year.md index 31de319d..bf443165 100644 --- a/docs/defaults/both/year.md +++ b/docs/defaults/both/year.md @@ -29,14 +29,10 @@ libraries: - pmm: year ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -50,6 +46,10 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} + ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md index d5938f14..25cb56f9 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -31,14 +31,10 @@ libraries: - pmm: anilist ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 than 0 | @@ -50,6 +46,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index dc77b2a2..483a1d7c 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -29,14 +29,10 @@ libraries: - pmm: basic ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 than 0 | @@ -47,6 +43,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/flixpatrol.md b/docs/defaults/chart/flixpatrol.md index 15c822a9..3e6c125c 100644 --- a/docs/defaults/chart/flixpatrol.md +++ b/docs/defaults/chart/flixpatrol.md @@ -34,14 +34,10 @@ libraries: - pmm: flixpatrol ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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:** Any Number 1-10 | @@ -55,6 +51,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index cb2752c7..64dc0c7d 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -32,14 +32,10 @@ libraries: - pmm: imdb ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - | Variable | Description & Values | |:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.
**Default:** `sync`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| @@ -49,6 +45,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index 52ff2014..c8994095 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -32,14 +32,10 @@ libraries: - pmm: myanimelist ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 than 0 | @@ -51,6 +47,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index f068e81f..7a7b4ae6 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -33,14 +33,10 @@ libraries: - pmm: other_chart ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 than 0 | @@ -51,6 +47,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 94746cbc..71e1fa14 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -31,14 +31,10 @@ libraries: - pmm: tautulli ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 than 0 | @@ -52,6 +48,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index c1220355..d583751c 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -34,14 +34,10 @@ libraries: - pmm: tmdb ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 than 0 | @@ -53,6 +49,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index b96de90e..7a468b54 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -35,14 +35,10 @@ libraries: - pmm: trakt ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) 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 than 0 | @@ -54,6 +50,9 @@ All [Shared Collection Variables](../collection_variables.md) are available as w 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/collection_variables.md b/docs/defaults/collection_variables.md index ca41402a..1b15213e 100644 --- a/docs/defaults/collection_variables.md +++ b/docs/defaults/collection_variables.md @@ -1,17 +1,9 @@ -# Shared Collection Template Variables +## Shared Collection Template Variables -IMPORTANT: The variables in this table are only valid in the context of the [`PMM default metadata files`](guide.md. - -There are some `template_variables` that all the PMM Defaults except [`franchise`](movie/franchise.md) and [`collectionless`](both/collectionless.md) can use to manipulate the file from the default settings which are provided. This page is not an exhaustive list of all such template variables. - -The variables listed on this page are common to all default collection files [aside from `franchise` and `collectionless`]; each individual collection file *may* have other template variables available. Those will be listed on the wiki page for each individual default collection file. - -Some of these template variables may have default values depending on the specific collection file. Those default values will also be listed on the individual collection file page. +The below template variables are available for this PMM Defaults file. Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. -Below are the common variables which can be used to customize the file. - | Variable | Description & Values | |:-----------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `language` | **Description:** Set the language of Collection Names and Summaries
**Default:** `default`
**Values:** `default` (English), `fr` (French), or `de` (German) | @@ -64,4 +56,4 @@ Below are the common variables which can be used to customize the file. | `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | | `item_sonarr_tag_<>`1 | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's collection.
**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. +1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. \ No newline at end of file diff --git a/docs/defaults/files.md b/docs/defaults/files.md index ce14e07d..08ea77eb 100644 --- a/docs/defaults/files.md +++ b/docs/defaults/files.md @@ -16,6 +16,6 @@ These files apply playlists to the "Playlists" section of Plex and are applied b ### Playlist Files -| Default | path | Example Overlays | -|:---------------------|:-----------|:-------------------------------------------------------| -| [Playlist](playlist.md) | `playlist` | Arrowverse (Timeline Order), Pokémon (Timeline Order) | +| Default | path | Example Overlays | +|:--------------------------|:------------|:-------------------------------------------------------| +| [Playlist](playlist.md) | `playlist` | Arrowverse (Timeline Order), Pokémon (Timeline Order) | diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index 6fbfa7ac..6bd1f096 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -33,14 +33,10 @@ libraries: - pmm: content_rating_us ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -61,6 +57,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/continent.md b/docs/defaults/movie/continent.md index a89b0efd..3dc98c1c 100644 --- a/docs/defaults/movie/continent.md +++ b/docs/defaults/movie/continent.md @@ -35,14 +35,10 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ![](../images/continent2.png) -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -64,6 +60,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index a1586b36..8149420a 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -35,14 +35,10 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ![](../images/country2.png) -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -64,6 +60,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index 8acdd56a..6026a82d 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -28,14 +28,10 @@ libraries: - pmm: decade ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -50,6 +46,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index 3d3afeae..c71faa52 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -28,14 +28,10 @@ libraries: - pmm: director ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -55,6 +51,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 55369e3e..5434c525 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -69,6 +69,9 @@ Note that the `template_variables:` section only needs to be used if you do want 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index 42cff293..a664822d 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -28,14 +28,10 @@ libraries: - pmm: producer ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -55,6 +51,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/region.md b/docs/defaults/movie/region.md index 5e5c83d4..81f87408 100644 --- a/docs/defaults/movie/region.md +++ b/docs/defaults/movie/region.md @@ -35,14 +35,10 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ![](../images/region2.png) -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -64,6 +60,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/seasonal.md b/docs/defaults/movie/seasonal.md index d2e62641..600794b6 100644 --- a/docs/defaults/movie/seasonal.md +++ b/docs/defaults/movie/seasonal.md @@ -44,14 +44,10 @@ libraries: - pmm: seasonal ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -79,6 +75,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index 0985256d..2a3596af 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -28,14 +28,10 @@ libraries: - pmm: writer ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -55,6 +51,12 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlay_text_variables.md b/docs/defaults/overlay_text_variables.md new file mode 100644 index 00000000..e2235db0 --- /dev/null +++ b/docs/defaults/overlay_text_variables.md @@ -0,0 +1,18 @@ +## Text Overlay Template Variables + +The below additional template variables are available for this PMM Defaults file as it is a text-based overlay. + +| Variable | Description & Values | +|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `font` | **Description:** Choose the font for the Overlay.
**Default:** `fonts/Inter-Medium.ttf`
**Values:** Path to font file | +| `font_style` | **Description:** Font style for Variable Fonts.
**Values:** Variable Font Style | +| `font_size` | **Description:** Choose the font size for the Overlay.
**Default:** `55`
**Values:** Any number greater than 0 | +| `font_color` | **Description:** Choose the font color for the Overlay.
**Default:** `#FFFFFF`
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | +| `stroke_width` | **Description:** Font Stroke Width for the Overlay.
**Values:** Any number greater than 0 | +| `stroke_color` | **Description:** Font Stroke Color for the Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | +| `font_<>` | **Description:** Choose the font for this key's Overlay.
**Default:** `fonts/Inter-Medium.ttf`
**Values:** Path to font file | +| `font_style_<>` | **Description:** Font style for this key's Variable Fonts.
**Values:** Variable Font Style | +| `font_size_<>` | **Description:** Choose the font size for this key's Overlay.
**Default:** `55`
**Values:** Any number greater than 0 | +| `font_color_<>` | **Description:** Choose the font color for this key's Overlay.
**Default:** `#FFFFFF`
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | +| `stroke_width_<>` | **Description:** Font Stroke Width for this key's Overlay.
**Values:** Any number greater than 0 | +| `stroke_color_<>` | **Description:** Font Stroke Color for this key's Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | \ No newline at end of file diff --git a/docs/defaults/overlay_variables.md b/docs/defaults/overlay_variables.md index 2b84f84f..663a8b2c 100644 --- a/docs/defaults/overlay_variables.md +++ b/docs/defaults/overlay_variables.md @@ -1,19 +1,9 @@ -# Shared Overlay Template Variables +## Shared Overlay Template Variables -???+ important - - The variables in this table are only valid in the context of the PMM Defaults Overlay files and will not work with non-Defaults files that have been manually created using builders. - -There are some `template_variables` that all the PMM Defaults except `franchise` can use to manipulate the file from the default settings which are provided. This page is not an exhaustive list of all such template variables. - -The variables listed on this page are common to all default overlay files [aside from `franchise`]; each individual overlay *may* have other template variables available. Those will be listed on the wiki page for each individual default overlay file. - -Some of these template variables may have default values depending on the specific overlay. Those default values will also be listed on the individual overlay page. +The below template variables are available for this PMM Defaults file. Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. -Below are the common variables which can be used to customize the file. - | Variable | Description & Values | |:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_<>`1 | **Description:** Turns off individual Overlays in a Defaults file.
**Values:** `false` to turn off the overlay | @@ -38,32 +28,4 @@ Below are the common variables which can be used to customize the file. | `back_line_color` | **Description:** Controls the Backdrop Line Color for the Text Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA``AA` is transparency; 00 [transparent] to FF [opaque] | | `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.
**Values:** Any number greater than 0 | -1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. - -# Text Overlay Template Variables - -The below `template_variables` are also available for Overlays which have text written, allowing for further customization of the text that appears. - -???+ note - - This will not work for images of text such as the Resolution overlays, this is specifically for text which Plex Meta Manager writes such as the Direct Play overlay - -Some of these template variables may have default values depending on the specific overlay. Those default values will also be listed on the individual overlay page. - -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. - - -| Variable | Description & Values | -|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `font` | **Description:** Choose the font for the Overlay.
**Default:** `fonts/Inter-Medium.ttf`
**Values:** Path to font file | -| `font_style` | **Description:** Font style for Variable Fonts.
**Values:** Variable Font Style | -| `font_size` | **Description:** Choose the font size for the Overlay.
**Default:** `55`
**Values:** Any number greater than 0 | -| `font_color` | **Description:** Choose the font color for the Overlay.
**Default:** `#FFFFFF`
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | -| `stroke_width` | **Description:** Font Stroke Width for the Overlay.
**Values:** Any number greater than 0 | -| `stroke_color` | **Description:** Font Stroke Color for the Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | -| `font_<>` | **Description:** Choose the font for this key's Overlay.
**Default:** `fonts/Inter-Medium.ttf`
**Values:** Path to font file | -| `font_style_<>` | **Description:** Font style for this key's Variable Fonts.
**Values:** Variable Font Style | -| `font_size_<>` | **Description:** Choose the font size for this key's Overlay.
**Default:** `55`
**Values:** Any number greater than 0 | -| `font_color_<>` | **Description:** Choose the font color for this key's Overlay.
**Default:** `#FFFFFF`
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | -| `stroke_width_<>` | **Description:** Font Stroke Width for this key's Overlay.
**Values:** Any number greater than 0 | -| `stroke_color_<>` | **Description:** Font Stroke Color for this key's Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | +1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. \ No newline at end of file diff --git a/docs/defaults/overlays/aspect.md b/docs/defaults/overlays/aspect.md index 9a3162b4..176a7667 100644 --- a/docs/defaults/overlays/aspect.md +++ b/docs/defaults/overlays/aspect.md @@ -41,31 +41,32 @@ libraries: builder_level: season ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `150` | -| `horizontal_align` | `center` | -| `vertical_offset` | `0` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105` | - -| Variable | Description & Values | +| Variable( )| Default / Values( / Values )| |:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `150` | +| `horizontal_align` | `center` | +| `vertical_offset` | `0` | +| `vertical_align` | `bottom` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `105` || | `text_<>`1 | **Description:** Choose the text for the Overlay.
**Default:**
KeyDefault
`1.33``1.33`
`1.65``1.65`
`1.66``1.66`
`1.78``1.78`
`1.85``1.85`
`2.2``2.2`
`2.35``2.35`
`2.77``2.77`
**Values:** Any String | | `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | -1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. +{% + include-markdown "../overlay_variables.md" +%} + +{% + include-markdown "../overlay_text_variables.md" +%} + +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. @@ -93,4 +94,4 @@ libraries: overlay_level: season text_1.33: "4:9" text_1.77: "16:9" -``` +``` \ No newline at end of file diff --git a/docs/defaults/overlays/audio_codec.md b/docs/defaults/overlays/audio_codec.md index e922e5bf..4457cf04 100644 --- a/docs/defaults/overlays/audio_codec.md +++ b/docs/defaults/overlays/audio_codec.md @@ -57,27 +57,20 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `0` | -| `horizontal_align` | `center` | -| `vertical_offset` | `15` | -| `vertical_align` | `top` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105`/`189` | - -| Variable | Description & Values | +| Variable | Default / Values | |:-----------------------------|:-------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `0` | +| `horizontal_align` | `center` | +| `vertical_offset` | `15` | +| `vertical_align` | `top` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `105`/`189` | | `style` | **Description:** Choose the Overlay Style.
**Default:** `compact`
**Values:** `compact` or `standard` | | `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | | `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | @@ -85,6 +78,12 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. +{% + include-markdown "../overlay_variables.md" +%} + +## Example Template Variable Amendments + 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/overlays/commonsense.md b/docs/defaults/overlays/commonsense.md index 6c56616c..ea834ea9 100644 --- a/docs/defaults/overlays/commonsense.md +++ b/docs/defaults/overlays/commonsense.md @@ -54,34 +54,33 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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. +| Variable | Default / Values | +|:----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `270` | +| `vertical_align` | `bottom` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `105` | +| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | +| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `left`
**Values:** `left`, `right`, `top`, `bottom` | +| `pre_text` | **Description:** Choose the text before the key for the Overlay.
**Values:** Any String | +| `post_text` | **Description:** Choose the text after the key for the Overlay.
**Default:** `+`
**Values:** Any String | +| `pre_nr_text` | **Description:** Choose the text before the `nr` key for the Overlay.
**Values:** Any String | +| `post_nr_text` | **Description:** Choose the text after the `nr` key for the Overlay.
**Values:** Any String | +| `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | -All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. +{% + include-markdown "../overlay_variables.md" +%} -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `270` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105` | - -| Variable | Description & Values | -|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | -| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `left`
**Values:** `left`, `right`, `top`, `bottom` | -| `pre_text` | **Description:** Choose the text before the key for the Overlay.
**Values:** Any String | -| `post_text` | **Description:** Choose the text after the key for the Overlay.
**Default:** `+`
**Values:** Any String | -| `pre_nr_text` | **Description:** Choose the text before the `nr` key for the Overlay.
**Values:** Any String | -| `post_nr_text` | **Description:** Choose the text after the `nr` key for the Overlay.
**Values:** Any String | -| `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/content_rating_uk.md b/docs/defaults/overlays/content_rating_uk.md index 1dd63703..00323e30 100644 --- a/docs/defaults/overlays/content_rating_uk.md +++ b/docs/defaults/overlays/content_rating_uk.md @@ -43,15 +43,11 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - -| Variable | Default | +| Variable | Default / Values | |:--------------------|:---------| | `color` | `` | | `horizontal_offset` | `15` | @@ -70,6 +66,12 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d | `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `left`
**Values:** `left`, `right`, `top`, `bottom` | | `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | +{% + include-markdown "../overlay_variables.md" +%} + +## Example Template Variable Amendments + 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/overlays/content_rating_us_movie.md b/docs/defaults/overlays/content_rating_us_movie.md index 200f6d6c..45beb2dc 100644 --- a/docs/defaults/overlays/content_rating_us_movie.md +++ b/docs/defaults/overlays/content_rating_us_movie.md @@ -32,31 +32,30 @@ libraries: - pmm: content_rating_us_movie ``` -## Template Variables +## Template Variable Default Values 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 `template_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. +| Variable | Default / Values | +|:--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------| +| `color` | `` | +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `270` | +| `vertical_align` | `bottom` | +| `color` | **Description:** Color version of the content rating images
**Default:**`` Set to `false` if you want b&w version. | +| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.
**Default:**`#00000099` | +| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.
**Default:**`30` | +| `back_width` | **Description:** Choose the back width for the overlay lozenge.
**Default:**`305` | +| `back_height` | **Description:** Choose the back height for the overlay lozenge.
**Default:**`105` | +| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | +| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `left`
**Values:** `left`, `right`, `top`, `bottom` | -All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. +{% + include-markdown "../overlay_variables.md" +%} -| Variable | Default | -|:--------------------|:---------| -| `color` | `` | -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `270` | -| `vertical_align` | `bottom` | - -| Variable | Description & Values | -|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `color` | **Description:** Color version of the content rating images
**Default:**`` Set to `false` if you want b&w version. | -| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.
**Default:**`#00000099` | -| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.
**Default:**`30` | -| `back_width` | **Description:** Choose the back width for the overlay lozenge.
**Default:**`305` | -| `back_height` | **Description:** Choose the back height for the overlay lozenge.
**Default:**`105` | -| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | -| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `left`
**Values:** `left`, `right`, `top`, `bottom` | +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/content_rating_us_show.md b/docs/defaults/overlays/content_rating_us_show.md index fb8a0679..226faa5b 100644 --- a/docs/defaults/overlays/content_rating_us_show.md +++ b/docs/defaults/overlays/content_rating_us_show.md @@ -38,31 +38,30 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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. +| Variable | Default / Values | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------| +| `color` | `` | +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `270` | +| `vertical_align` | `bottom` | +| `color` | **Description:** Color version of the content rating images
**Default:**`` Set to `false` if you want b&w version. | +| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.
**Default:**`#00000099` | +| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.
**Default:**`30` | +| `back_width` | **Description:** Choose the back width for the overlay lozenge.
**Default:**`305` | +| `back_height` | **Description:** Choose the back height for the overlay lozenge.
**Default:**`105` | +| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | +| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `left`
**Values:** `left`, `right`, `top`, `bottom` | -All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. +{% + include-markdown "../overlay_variables.md" +%} -| Variable | Default | -|:--------------------|:---------| -| `color` | `` | -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `270` | -| `vertical_align` | `bottom` | - -| Variable | Description & Values | -|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `color` | **Description:** Color version of the content rating images
**Default:**`` Set to `false` if you want b&w version. | -| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.
**Default:**`#00000099` | -| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.
**Default:**`30` | -| `back_width` | **Description:** Choose the back width for the overlay lozenge.
**Default:**`305` | -| `back_height` | **Description:** Choose the back height for the overlay lozenge.
**Default:**`105` | -| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | -| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `left`
**Values:** `left`, `right`, `top`, `bottom` | +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/direct_play.md b/docs/defaults/overlays/direct_play.md index c2a280bc..4ade9682 100644 --- a/docs/defaults/overlays/direct_play.md +++ b/docs/defaults/overlays/direct_play.md @@ -22,28 +22,31 @@ libraries: - pmm: direct_play ``` -## Template Variables +## Template Variable Default Values 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 `template_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. +| Variable | Default / Values | +|:--------------------|:--------------------------------------------------------------------------------| +| `horizontal_offset` | `0` | +| `horizontal_align` | `center` | +| `vertical_offset` | `150` | +| `vertical_align` | `bottom` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `170` | +| `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | -All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. +{% + include-markdown "../overlay_variables.md" +%} -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `0` | -| `horizontal_align` | `center` | -| `vertical_offset` | `150` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `170` | +{% + include-markdown "../overlay_text_variables.md" +%} -| Variable | Description & Values | -|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/episode_info.md b/docs/defaults/overlays/episode_info.md index 15669bf1..0da957db 100644 --- a/docs/defaults/overlays/episode_info.md +++ b/docs/defaults/overlays/episode_info.md @@ -19,24 +19,30 @@ libraries: - pmm: episode_info ``` -## Template Variables +## Template Variable Default Values 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 `template_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. +| Variable | Default / Values | +|:----------------------|:-----------------| +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `270` | +| `vertical_align` | `bottom` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `105` | -All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. +{% + include-markdown "../overlay_variables.md" +%} -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `270` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105` | +{% + include-markdown "../overlay_text_variables.md" +%} + +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/flixpatrol.md b/docs/defaults/overlays/flixpatrol.md index bc028ac0..1271d541 100644 --- a/docs/defaults/overlays/flixpatrol.md +++ b/docs/defaults/overlays/flixpatrol.md @@ -34,41 +34,55 @@ libraries: - pmm: flixpatrol ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) except `horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are available with the default values below as well as the additional Variables below which can be used to customize the file. -| Variable | Default | -|:--------------------|:------------------| -| `horizontal_offset` | `30` | -| `horizontal_align` | `left`/`right` | -| `vertical_offset` | `465`/`670`/`875` | -| `vertical_align` | `top` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `160` | -| `back_height` | `160` | -| `back_padding` | `15` | - -| Variable | Description & Values | -|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `position` | **Description:** Changes the position of the Overlays.
**Default:** `right`
**Values:** `right`, `left`, or List of Coordinates | -| `style` | **Description:** Changes the style of the Logo Image.
**Default:** `round`
**Values:** `round` or `square` | -| `pre_text` | **Description:** Changes the text before the number.
**Default:** `TOP`
**Values:** Any String | -| `limit` | **Description:** Changes the Builder Limit for all overlays in a Defaults file.
**Default:** `10`
**Values:** Any Number 1-10 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's overlay.
**Default:** `limit`
**Values:** Any Number 1-10 | -| `location` | **Description:** Changes the Builder Location for all overlays in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) | -| `location_<>`1 | **Description:** Changes the Builder Location of the specified key's overlay.
**Default:** `location`
**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) | -| `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | -| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `30`
**Values:** Any Number greater then 0 | -| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `top`
**Values:** `left`, `right`, `top`, `bottom` | +| Variable | Default / Values | +|:-------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `30` | +| `horizontal_align` | `left`/`right` | +| `vertical_offset` | `465`/`670`/`875` | +| `vertical_align` | `top` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `160` | +| `back_height` | `160` | +| `back_padding` | `15` | +| `position` | **Description:** Changes the position of the Overlays.
**Default:** `right`
**Values:** `right`, `left`, or List of Coordinates | +| `style` | **Description:** Changes the style of the Logo Image.
**Default:** `round`
**Values:** `round` or `square` | +| `pre_text` | **Description:** Changes the text before the number.
**Default:** `TOP`
**Values:** Any String | +| `limit` | **Description:** Changes the Builder Limit for all overlays in a Defaults file.
**Default:** `10`
**Values:** Any Number 1-10 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's overlay.
**Default:** `limit`
**Values:** Any Number 1-10 | +| `location` | **Description:** Changes the Builder Location for all overlays in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) | +| `location_<>`1 | **Description:** Changes the Builder Location of the specified key's overlay.
**Default:** `location`
**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) | +| `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | +| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `30`
**Values:** Any Number greater then 0 | +| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `top`
**Values:** `left`, `right`, `top`, `bottom` | 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. +{% + include-markdown "../overlay_variables.md" + end="Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored." +%} + +???+ bug "Warning" + + `horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are NOT available for use in this file + +{% + include-markdown "../overlay_variables.md" + start="The below template variables are available for this PMM Defaults file." +%} + +{% + include-markdown "../overlay_text_variables.md" +%} + +## Example Template Variable Amendments + 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/overlays/language_count.md b/docs/defaults/overlays/language_count.md index 2d04b41f..64b326cd 100644 --- a/docs/defaults/overlays/language_count.md +++ b/docs/defaults/overlays/language_count.md @@ -35,34 +35,33 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `0` | -| `horizontal_align` | `center` | -| `vertical_offset` | `30` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `188` | -| `back_height` | `105` | - -| Variable | Description & Values | -|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_subtitles` | **Description:** Controls if the overlay is based on subtitle language instead of audio language.
**Values:** `true` to look at subtitle language instead of audio language | -| `minimum` | **Description:** Choose the minimum for the `multi` Overlay.
**Default:** `2`
**Values:** Any Number | -| `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | -| `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | +| Variable | Default / Values | +|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `0` | +| `horizontal_align` | `center` | +| `vertical_offset` | `30` | +| `vertical_align` | `bottom` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `188` | +| `back_height` | `105` | +| `use_subtitles` | **Description:** Controls if the overlay is based on subtitle language instead of audio language.
**Values:** `true` to look at subtitle language instead of audio language | +| `minimum` | **Description:** Choose the minimum for the `multi` Overlay.
**Default:** `2`
**Values:** Any Number | +| `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | +| `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. +{% + include-markdown "../overlay_variables.md" +%} + +## Example Template Variable Amendments + 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/overlays/languages.md b/docs/defaults/overlays/languages.md index ead57d16..e58d131c 100644 --- a/docs/defaults/overlays/languages.md +++ b/docs/defaults/overlays/languages.md @@ -118,30 +118,23 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - -| Variable | Default | -|:--------------------|:-----------------------------| -| `horizontal_offset` | `15`/`206`/`397`/`588`/`779` | -| `horizontal_align` | `left`/`right`/`center` | -| `vertical_offset` | `15`/`76`/`137`/`198`/`259` | -| `vertical_align` | `top`/`bottom`/`center` | -| `back_color` | `#00000099` | -| `back_radius` | `26`/` ` | -| `back_width` | `190` | -| `back_height` | `105` | -| `back_align` | `left`/`right` | -| `font` | `fonts/Inter-Bold.ttf` | -| `font_size` | `50` | - -| Variable | Description & Values | +| Variable | Default / Values | |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `15`/`206`/`397`/`588`/`779` | +| `horizontal_align` | `left`/`right`/`center` | +| `vertical_offset` | `15`/`76`/`137`/`198`/`259` | +| `vertical_align` | `top`/`bottom`/`center` | +| `back_color` | `#00000099` | +| `back_radius` | `26`/` ` | +| `back_width` | `190` | +| `back_height` | `105` | +| `back_align` | `left`/`right` | +| `font` | `fonts/Inter-Bold.ttf` | +| `font_size` | `50` | | `languages` | **Description:** Controls which Languages will be active.
**Default:** `["en", "de", "fr", "es", "pt", "ja"]`
**Values:** List of [ISO 639-1 Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the Languages desired | | `use_subtitles` | **Description:** Controls if the overlay is based on subtitle language instead of audio language.
**Values:** `true` to look at subtitle language instead of audio language | | `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | @@ -159,6 +152,16 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. +{% + include-markdown "../overlay_variables.md" +%} + +{% + include-markdown "../overlay_text_variables.md" +%} + +## Example Template Variable Amendments + 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/overlays/mediastinger.md b/docs/defaults/overlays/mediastinger.md index e366783c..730fbfad 100644 --- a/docs/defaults/overlays/mediastinger.md +++ b/docs/defaults/overlays/mediastinger.md @@ -19,24 +19,26 @@ libraries: - pmm: mediastinger ``` -## Template Variables +## Template Variable Default Values 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 `template_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. +| Variable | Default / Values | +|:--------------------|:-------------------| +| `horizontal_offset` | `200` | +| `horizontal_align` | `right` | +| `vertical_offset` | `15` | +| `vertical_align` | `top` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `105` | +| `back_height` | `105` | -All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. +{% + include-markdown "../overlay_variables.md" +%} -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `200` | -| `horizontal_align` | `right` | -| `vertical_offset` | `15` | -| `vertical_align` | `top` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `105` | -| `back_height` | `105` | +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/network.md b/docs/defaults/overlays/network.md index a6cdd6ba..8f23b21e 100644 --- a/docs/defaults/overlays/network.md +++ b/docs/defaults/overlays/network.md @@ -25,25 +25,27 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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. +| Variable | Default / Values | +|:--------------------|:-----------------| +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `510` | +| `vertical_align` | `bottom` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `105` | -All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `510` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105` | +{% + include-markdown "../overlay_variables.md" +%} +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/ratings.md b/docs/defaults/overlays/ratings.md index 3bcc4f2b..cbeff935 100644 --- a/docs/defaults/overlays/ratings.md +++ b/docs/defaults/overlays/ratings.md @@ -60,33 +60,28 @@ The below YAML in your config.yml will create the overlays: mass_episode_audience_rating_update: tmdb ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. These can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually. +These can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually. ???+ warning To amend `horizontal_offset` and `vertical_offset` you **must** prepend the variable with `rating1_`, `rating2_`, or `rating3_` -| Variable | Default | -|:---------------------|:------------| -| `horizontal_offset` | `30` | -| `horizontal_align` | `left` | -| `vertical_offset` | `0` | -| `vertical_align` | `center` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `160` | -| `back_height` | `160` | -| `back_padding` | `15` | -| `back_radius` | `30` | - -| Variable | Description & Values | +| Variable | Default / Values | |:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `30` | +| `horizontal_align` | `left` | +| `vertical_offset` | `0` | +| `vertical_align` | `center` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `160` | +| `back_height` | `160` | +| `back_padding` | `15` | +| `back_radius` | `30` | | `rating1` | **Description:** Choose the rating to display in rating1.
**Values:** `critic`, `audience`, or `user` | | `rating1_image` | **Description:** Choose the rating image to display in rating1.
**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | | `rating1_style` | **Description:** Choose the rating number style for rating1.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| @@ -111,6 +106,16 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d 1. These Variables can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually. +{% + include-markdown "../overlay_variables.md" +%} + +{% + include-markdown "../overlay_text_variables.md" +%} + +## Example Template Variable Amendments + The below is an example config.yml extract with some Template Variables added in to change how the file works. **Note: This example uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)** diff --git a/docs/defaults/overlays/resolution.md b/docs/defaults/overlays/resolution.md index b9dd946b..a57c6576 100644 --- a/docs/defaults/overlays/resolution.md +++ b/docs/defaults/overlays/resolution.md @@ -110,27 +110,20 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `15` | -| `vertical_align` | `top` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105`/`189` | - -| Variable | Description & Values | +| Variable | Default / Values | |:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `15` | +| `vertical_align` | `top` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `105`/`189` | | `use_resolution` | **Description:** Turns off all Resolution Overlays in the Defaults file.
**Values:** `false` to turn off the overlays | | `use_edition` | **Description:** Turns off all Edition Overlays in the Defaults file.
**Values:** `false` to turn off the overlays | | `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | @@ -138,6 +131,12 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. +{% + include-markdown "../overlay_variables.md" +%} + +## Example Template Variable Amendments + 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/overlays/ribbon.md b/docs/defaults/overlays/ribbon.md index a185f9ab..425c5fd8 100644 --- a/docs/defaults/overlays/ribbon.md +++ b/docs/defaults/overlays/ribbon.md @@ -45,29 +45,31 @@ libraries: - pmm: ribbon ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. +. -| Variable | Default | -|:--------------------|:----------| -| `horizontal_offset` | `0` | -| `horizontal_align` | `right` | -| `vertical_offset` | `0` | -| `vertical_align` | `bottom` | - -| Variable | Description & Values | +| Variable | Default / Values | |:-----------------------------|:------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `0` | +| `horizontal_align` | `right` | +| `vertical_offset` | `0` | +| `vertical_align` | `bottom` | | `use_all` | **Description:** Used to turn on/off all keys.
**Default:** `true`
**Values:** `true` or `false` | | `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | | `style` | **Description:** Controls the color of the ribbon.
**Default:** `yellow`
**Values:** `yellow, gray, black, red` | 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. +{% + include-markdown "../overlay_variables.md" +%} + +## Example Template Variable Amendments + 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/overlays/runtimes.md b/docs/defaults/overlays/runtimes.md index 2cd7d68e..ca91693e 100644 --- a/docs/defaults/overlays/runtimes.md +++ b/docs/defaults/overlays/runtimes.md @@ -25,28 +25,31 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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. +| Variable | Default / Values | +|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `15` | +| `horizontal_align` | `right` | +| `vertical_offset` | `30` | +| `vertical_align` | `bottom` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `600` | +| `back_height` | `105` | +| `text` | **Description:** Choose the text that appears prior to the runtime on the Overlay.
**Default:** `Runtime: `
**Values:** Any String | -All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. +{% + include-markdown "../overlay_variables.md" +%} -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `15` | -| `horizontal_align` | `right` | -| `vertical_offset` | `30` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `600` | -| `back_height` | `105` | +{% + include-markdown "../overlay_text_variables.md" +%} -| Variable | Description & Values | -|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `text` | **Description:** Choose the text for the Overlay.
**Default:** `Runtime: `
**Values:** Any String | +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/status.md b/docs/defaults/overlays/status.md index ecf13d0f..5369ceac 100644 --- a/docs/defaults/overlays/status.md +++ b/docs/defaults/overlays/status.md @@ -28,33 +28,36 @@ libraries: - pmm: status ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `330` | -| `vertical_align` | `top` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105` | - -| Variable | Description & Values | +| Variable | Default / Values | |:-----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `330` | +| `vertical_align` | `top` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `105` | | `last` | **Description:** Episode Air Date in the last number of days for the AIRING Overlay.
**Default:** `14`
**Values:** Any number greater than 0 | | `text_<>`1 | **Description:** Choose the text for the Overlay.
**Default:**
KeyDefault
`airing``AIRING`
`returning``RETURNING`
`canceled``CANCELED`
`ended``ENDED`
**Values:** Any String | | `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. +{% + include-markdown "../overlay_variables.md" +%} + +{% + include-markdown "../overlay_text_variables.md" +%} + +## Example Template Variable Amendments + 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/overlays/streaming.md b/docs/defaults/overlays/streaming.md index dc2a6cdf..cfd6563f 100644 --- a/docs/defaults/overlays/streaming.md +++ b/docs/defaults/overlays/streaming.md @@ -47,14 +47,10 @@ libraries: - pmm: streaming ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - | Variable | Description & Values | |:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `horizontal_offset` | **Description:** Change the horizontal offset.
**Default Value:** `15` | @@ -82,6 +78,12 @@ Some logic is applied to allow for regional streaming service lists to be availa | any besides `ca` | `crave` | These overlays will not be used if the region is not `ca` as these streaming services are Canada-focused | | `ca` | `max`, `showtime` | These overlays will not be used if the region is `ca` as these streaming services are part of the Crave streaming service in Canada | +{% + include-markdown "../overlay_variables.md" +%} + +## Example Template Variable Amendments + 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/overlays/studio.md b/docs/defaults/overlays/studio.md index 005c842c..15a6be26 100644 --- a/docs/defaults/overlays/studio.md +++ b/docs/defaults/overlays/studio.md @@ -22,27 +22,20 @@ libraries: - pmm: studio ``` -## Template Variables +## Template Variable Default Values -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. +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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `150` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105` | - -| Variable | Description & Values | +| Variable | Default / Values | |:--------------------|:-------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `150` | +| `vertical_align` | `bottom` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `105` | | `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | | `style` | **Description:** Choose between the standard size or the **bigger** one.
**Values:** `bigger` | @@ -50,6 +43,11 @@ Preview of the bigger style ![](images/studio_bigger.jpg) +{% + include-markdown "../overlay_variables.md" +%} + +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/versions.md b/docs/defaults/overlays/versions.md index 1b29d6a3..7e8f2008 100644 --- a/docs/defaults/overlays/versions.md +++ b/docs/defaults/overlays/versions.md @@ -28,28 +28,27 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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. +| Variable | Default / Values | +|:--------------------|:--------------------------------------------------------------------------------| +| `horizontal_offset` | `15`/`235` | +| `horizontal_align` | `right`/`center` | +| `vertical_offset` | `1050`/`15` | +| `vertical_align` | `top` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `105` | +| `back_height` | `105` | +| `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | -All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. +{% + include-markdown "../overlay_variables.md" +%} -| Variable | Default | -|:--------------------|:-----------------| -| `horizontal_offset` | `15`/`235` | -| `horizontal_align` | `right`/`center` | -| `vertical_offset` | `1050`/`15` | -| `vertical_align` | `top` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `105` | -| `back_height` | `105` | - -| Variable | Description & Values | -|:----------------|:--------------------------------------------------------------------------------| -| `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | +## Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/overlays/video_format.md b/docs/defaults/overlays/video_format.md index 16d724d3..c986df3b 100644 --- a/docs/defaults/overlays/video_format.md +++ b/docs/defaults/overlays/video_format.md @@ -41,27 +41,20 @@ libraries: builder_level: episode ``` -## Template Variables +## Template Variable Default Values 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 `template_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 Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. - -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `30` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105` | - -| Variable | Description & Values | +| Variable | Default / Values | |:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `30` | +| `vertical_align` | `bottom` | +| `back_color` | `#00000099` | +| `back_radius` | `30` | +| `back_width` | `305` | +| `back_height` | `105` | | `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | | `text_<>`1 | **Description:** Choose the text for the Overlay.
**Default:**
KeyDefault
`remux``REMUX`
`bluray``BLU-RAY`
`web``WEB`
`hdtv``HDTV`
`dvd``DVD`
`sdtv``SDTV`
**Values:** Any String | | `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | @@ -69,6 +62,16 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. +{% + include-markdown "../overlay_variables.md" +%} + +{% + include-markdown "../overlay_text_variables.md" +%} + +## Example Template Variable Amendments + 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/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index 9e8a325b..57457474 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -31,14 +31,10 @@ libraries: - pmm: content_rating_us ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -59,6 +55,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/show/continent.md b/docs/defaults/show/continent.md index 34ff1236..e01c8414 100644 --- a/docs/defaults/show/continent.md +++ b/docs/defaults/show/continent.md @@ -35,14 +35,10 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ![](../images/continent2.png) -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -67,6 +63,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index d6677217..beb86ff5 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -35,14 +35,10 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ![](../images/country2.png) -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -67,6 +63,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index 08e53c0a..2c7c0cd9 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -28,14 +28,10 @@ libraries: - pmm: decade ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -50,6 +46,12 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index 8ec6c1b0..241315c9 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -69,6 +69,9 @@ Note that the `template_variables:` section only needs to be used if you do want 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index 5b9d0acf..05443f59 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -26,14 +26,10 @@ libraries: - pmm: network ``` -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -54,6 +50,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/show/region.md b/docs/defaults/show/region.md index 3ebbbc91..5654a362 100644 --- a/docs/defaults/show/region.md +++ b/docs/defaults/show/region.md @@ -35,14 +35,10 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ![](../images/region2.png) -## Template Variables +## Template Variable Default Values 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 `template_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](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. | Variable | Description & Values | @@ -67,6 +63,9 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +{% + include-markdown "../collection_variables.md" +%} ### Example Template Variable Amendments The below is an example config.yml extract with some Template Variables added in to change how the file works.