From a9391fdb94bdc0fc9a9803670b14385329159b13 Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Fri, 5 Jan 2024 16:06:39 -0500 Subject: [PATCH] [83] lots of doc and default updates --- VERSION | 2 +- defaults/award/bafta.yml | 2 +- defaults/award/cannes.yml | 3 +- defaults/award/choice.yml | 4 +- defaults/award/emmy.yml | 2 +- defaults/award/golden.yml | 2 +- defaults/award/oscars.yml | 2 +- defaults/award/other_award.yml | 2 +- defaults/award/separator_award.yml | 2 +- defaults/award/spirit.yml | 4 +- defaults/award/sundance.yml | 2 +- defaults/both/actor.yml | 2 +- defaults/both/aspect.yml | 4 +- defaults/both/audio_language.yml | 2 +- defaults/both/based.yml | 2 +- defaults/both/collectionless.yml | 2 +- defaults/both/content_rating_cs.yml | 2 +- defaults/both/content_rating_de.yml | 2 +- defaults/both/content_rating_mal.yml | 2 +- defaults/both/content_rating_uk.yml | 2 +- defaults/both/genre.yml | 2 +- defaults/both/resolution.yml | 2 +- defaults/both/streaming.yml | 2 +- defaults/both/studio.yml | 2 +- defaults/both/subtitle_language.yml | 2 +- defaults/both/universe.yml | 5 +- defaults/both/year.yml | 2 +- defaults/chart/anilist.yml | 2 +- defaults/chart/basic.yml | 2 +- defaults/chart/flixpatrol.yml | 2 +- defaults/chart/imdb.yml | 2 +- defaults/chart/myanimelist.yml | 2 +- defaults/chart/other_chart.yml | 2 +- defaults/chart/separator_chart.yml | 2 +- defaults/chart/tautulli.yml | 2 +- defaults/chart/tmdb.yml | 2 +- defaults/chart/trakt.yml | 2 +- defaults/movie/content_rating_us.yml | 2 +- defaults/movie/continent.yml | 2 +- defaults/movie/country.yml | 2 +- defaults/movie/decade.yml | 2 +- defaults/movie/director.yml | 2 +- defaults/movie/franchise.yml | 4 +- defaults/movie/producer.yml | 2 +- defaults/movie/region.yml | 2 +- defaults/movie/seasonal.yml | 15 +- defaults/movie/writer.yml | 2 +- defaults/overlays/aspect.yml | 2 +- defaults/overlays/audio_codec.yml | 2 +- defaults/overlays/commonsense.yml | 2 +- defaults/overlays/content_rating_de.yml | 2 +- defaults/overlays/content_rating_uk.yml | 2 +- defaults/overlays/content_rating_us_movie.yml | 2 +- defaults/overlays/content_rating_us_show.yml | 2 +- defaults/overlays/direct_play.yml | 2 +- defaults/overlays/episode_info.yml | 2 +- defaults/overlays/flixpatrol.yml | 2 +- defaults/overlays/language_count.yml | 2 +- defaults/overlays/languages.yml | 2 +- defaults/overlays/mediastinger.yml | 2 +- defaults/overlays/network.yml | 2 +- defaults/overlays/ratings.yml | 2 +- defaults/overlays/resolution.yml | 2 +- defaults/overlays/ribbon.yml | 106 +++- defaults/overlays/runtimes.yml | 2 +- defaults/overlays/status.yml | 2 +- defaults/overlays/streaming.yml | 2 +- defaults/overlays/studio.yml | 2 +- defaults/overlays/versions.yml | 2 +- defaults/overlays/video_format.yml | 2 +- defaults/playlist.yml | 31 +- defaults/show/content_rating_us.yml | 2 +- defaults/show/continent.yml | 2 +- defaults/show/country.yml | 2 +- defaults/show/decade.yml | 2 +- defaults/show/franchise.yml | 2 +- defaults/show/network.yml | 2 +- defaults/show/region.yml | 2 +- docs/defaults/award/bafta.md | 24 +- docs/defaults/award/cannes.md | 4 +- docs/defaults/award/choice.md | 5 +- docs/defaults/award/emmy.md | 5 +- docs/defaults/award/golden.md | 5 +- docs/defaults/award/oscars.md | 5 +- docs/defaults/award/other.md | 12 +- docs/defaults/award/spirit.md | 6 +- docs/defaults/award/sundance.md | 4 +- docs/defaults/both/actor.md | 4 +- docs/defaults/both/aspect.md | 27 +- docs/defaults/both/audio_language.md | 13 +- docs/defaults/both/based.md | 22 +- docs/defaults/both/collectionless.md | 26 +- docs/defaults/both/content_rating_cs.md | 46 +- docs/defaults/both/content_rating_de.md | 44 +- docs/defaults/both/content_rating_mal.md | 44 +- docs/defaults/both/content_rating_uk.md | 44 +- docs/defaults/both/genre.md | 34 +- docs/defaults/both/resolution.md | 46 +- docs/defaults/both/streaming.md | 4 +- docs/defaults/both/studio.md | 44 +- docs/defaults/both/subtitle_language.md | 25 +- docs/defaults/both/universe.md | 60 +- docs/defaults/both/year.md | 44 +- docs/defaults/chart/anilist.md | 16 +- docs/defaults/chart/basic.md | 4 +- docs/defaults/chart/flixpatrol.md | 24 +- docs/defaults/chart/imdb.md | 12 +- docs/defaults/chart/myanimelist.md | 93 ++-- docs/defaults/chart/other.md | 14 +- docs/defaults/chart/tautulli.md | 20 +- docs/defaults/chart/tmdb.md | 16 +- docs/defaults/chart/trakt.md | 16 +- docs/defaults/movie/content_rating_us.md | 129 ++--- docs/defaults/movie/continent.md | 421 ++------------ docs/defaults/movie/country.md | 458 ++------------- docs/defaults/movie/decade.md | 18 +- docs/defaults/movie/director.md | 4 +- docs/defaults/movie/franchise.md | 100 ++-- docs/defaults/movie/producer.md | 4 +- docs/defaults/movie/region.md | 434 ++------------- docs/defaults/movie/seasonal.md | 282 +++++----- docs/defaults/movie/writer.md | 4 +- docs/defaults/overlays/aspect.md | 23 +- docs/defaults/overlays/audio_codec.md | 23 +- docs/defaults/overlays/commonsense.md | 39 +- docs/defaults/overlays/content_rating_de.md | 84 +-- docs/defaults/overlays/content_rating_uk.md | 38 +- .../overlays/content_rating_us_movie.md | 33 +- .../overlays/content_rating_us_show.md | 19 +- docs/defaults/overlays/direct_play.md | 27 +- docs/defaults/overlays/episode_info.md | 46 +- docs/defaults/overlays/flixpatrol.md | 52 +- docs/defaults/overlays/language_count.md | 23 +- docs/defaults/overlays/languages.md | 29 +- docs/defaults/overlays/mediastinger.md | 38 +- docs/defaults/overlays/network.md | 37 +- docs/defaults/overlays/ratings.md | 27 +- docs/defaults/overlays/resolution.md | 23 +- docs/defaults/overlays/ribbon.md | 16 +- docs/defaults/overlays/runtimes.md | 27 +- docs/defaults/overlays/status.md | 23 +- docs/defaults/overlays/streaming.md | 21 +- docs/defaults/overlays/studio.md | 29 +- docs/defaults/overlays/versions.md | 27 +- docs/defaults/overlays/video_format.md | 23 +- docs/defaults/playlist.md | 142 ++--- docs/defaults/show/content_rating_us.md | 121 ++-- docs/defaults/show/continent.md | 340 +----------- docs/defaults/show/country.md | 335 +---------- docs/defaults/show/decade.md | 18 +- docs/defaults/show/franchise.md | 126 ++--- docs/defaults/show/network.md | 520 ++---------------- docs/defaults/show/region.md | 350 +----------- modules/builder.py | 8 +- modules/imdb.py | 24 +- modules/overlays.py | 2 +- 156 files changed, 1755 insertions(+), 3938 deletions(-) diff --git a/VERSION b/VERSION index 12d20eb0..c5c4351a 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.19.1-develop82 +1.19.1-develop83 diff --git a/defaults/award/bafta.yml b/defaults/award/bafta.yml index 06be75a3..5f9f9898 100644 --- a/defaults/award/bafta.yml +++ b/defaults/award/bafta.yml @@ -2,7 +2,7 @@ # British Academy of Film and Television Arts Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/bafta.html # +# https://metamanager.wiki/en/latest/defaults/award/bafta # ############################################################################## external_templates: diff --git a/defaults/award/cannes.yml b/defaults/award/cannes.yml index f51174a7..a5ac1b3b 100644 --- a/defaults/award/cannes.yml +++ b/defaults/award/cannes.yml @@ -1,9 +1,8 @@ ############################################################################## # Cannes Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # -# Credit to pjcob & maxwelldeux for the Trakt Lists # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/cannes.html # +# https://metamanager.wiki/en/latest/defaults/award/cannes # ############################################################################## external_templates: diff --git a/defaults/award/choice.yml b/defaults/award/choice.yml index 1d8d25c1..99c2ee46 100644 --- a/defaults/award/choice.yml +++ b/defaults/award/choice.yml @@ -2,7 +2,7 @@ # Critics Choice Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/choice.html # +# https://metamanager.wiki/en/latest/defaults/award/choice # ############################################################################## external_templates: @@ -13,7 +13,7 @@ external_templates: collections: Critics Choice Best Picture Winners: variables: - key: choice + key: best template: - name: shared sort: Choice ! diff --git a/defaults/award/emmy.yml b/defaults/award/emmy.yml index adc7e8fb..ebf1fcc0 100644 --- a/defaults/award/emmy.yml +++ b/defaults/award/emmy.yml @@ -2,7 +2,7 @@ # Emmy Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/emmy.html # +# https://metamanager.wiki/en/latest/defaults/award/emmy # ############################################################################## external_templates: diff --git a/defaults/award/golden.yml b/defaults/award/golden.yml index 1c7198c3..e7afeb7d 100644 --- a/defaults/award/golden.yml +++ b/defaults/award/golden.yml @@ -2,7 +2,7 @@ # Golden Globes Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/golden.html # +# https://metamanager.wiki/en/latest/defaults/award/golden # ############################################################################## external_templates: diff --git a/defaults/award/oscars.yml b/defaults/award/oscars.yml index d3599206..a356d9fa 100644 --- a/defaults/award/oscars.yml +++ b/defaults/award/oscars.yml @@ -2,7 +2,7 @@ # Academy Awards (Oscars) Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/oscars.html # +# https://metamanager.wiki/en/latest/defaults/award/oscars # ############################################################################## external_templates: diff --git a/defaults/award/other_award.yml b/defaults/award/other_award.yml index c6057b55..09adbae4 100644 --- a/defaults/award/other_award.yml +++ b/defaults/award/other_award.yml @@ -2,7 +2,7 @@ # Other Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/other.html # +# https://metamanager.wiki/en/latest/defaults/award/other # ############################################################################## external_templates: diff --git a/defaults/award/separator_award.yml b/defaults/award/separator_award.yml index a73199de..8c8b0091 100644 --- a/defaults/award/separator_award.yml +++ b/defaults/award/separator_award.yml @@ -2,7 +2,7 @@ # Award Separator Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/separator_award.html # +# https://metamanager.wiki/en/latest/defaults/award/separator_award # ############################################################################## external_templates: diff --git a/defaults/award/spirit.yml b/defaults/award/spirit.yml index 378dd45d..2e149686 100644 --- a/defaults/award/spirit.yml +++ b/defaults/award/spirit.yml @@ -2,7 +2,7 @@ # Independent Spirit Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/spirit.html # +# https://metamanager.wiki/en/latest/defaults/award/spirit # ############################################################################## external_templates: @@ -13,7 +13,7 @@ external_templates: collections: Spirit Best Feature Winners: variables: - key: spirit + key: best template: - name: shared sort: Spirit !1 diff --git a/defaults/award/sundance.yml b/defaults/award/sundance.yml index 724d7b59..de3d95b4 100644 --- a/defaults/award/sundance.yml +++ b/defaults/award/sundance.yml @@ -2,7 +2,7 @@ # Sundance Awards Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/sundance.html # +# https://metamanager.wiki/en/latest/defaults/award/sundance # ############################################################################## external_templates: diff --git a/defaults/both/actor.yml b/defaults/both/actor.yml index 322fe25d..515068cf 100644 --- a/defaults/both/actor.yml +++ b/defaults/both/actor.yml @@ -2,7 +2,7 @@ # Actor Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/actor.html # +# https://metamanager.wiki/en/latest/defaults/both/actor # ############################################################################## external_templates: diff --git a/defaults/both/aspect.yml b/defaults/both/aspect.yml index 780ca607..d9492ce8 100644 --- a/defaults/both/aspect.yml +++ b/defaults/both/aspect.yml @@ -1,8 +1,8 @@ ############################################################################## # Aspect Ratio Collections # # Created by Yozora, Bullmoose20, & Sohjiro # -# EDITING THIS url_poster MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/aspect.html # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/both/aspect # ############################################################################## external_templates: diff --git a/defaults/both/audio_language.yml b/defaults/both/audio_language.yml index 2266dab4..b82ea9c0 100644 --- a/defaults/both/audio_language.yml +++ b/defaults/both/audio_language.yml @@ -2,7 +2,7 @@ # Audio Language Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/audio_language.html # +# https://metamanager.wiki/en/latest/defaults/both/audio_language # ############################################################################## external_templates: diff --git a/defaults/both/based.yml b/defaults/both/based.yml index 3ad05497..57490a01 100644 --- a/defaults/both/based.yml +++ b/defaults/both/based.yml @@ -2,7 +2,7 @@ # "Based On..." Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/based.html # +# https://metamanager.wiki/en/latest/defaults/both/based # ############################################################################## external_templates: diff --git a/defaults/both/collectionless.yml b/defaults/both/collectionless.yml index 49a97ce6..ed6a112c 100644 --- a/defaults/both/collectionless.yml +++ b/defaults/both/collectionless.yml @@ -2,7 +2,7 @@ # Collectionless Collection # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/collectionless.html # +# https://metamanager.wiki/en/latest/defaults/both/collectionless # ############################################################################## templates: diff --git a/defaults/both/content_rating_cs.yml b/defaults/both/content_rating_cs.yml index 6af14cbc..9ac860a4 100644 --- a/defaults/both/content_rating_cs.yml +++ b/defaults/both/content_rating_cs.yml @@ -2,7 +2,7 @@ # CommonSense Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_cs.html # +# https://metamanager.wiki/en/latest/defaults/both/content_rating_cs # ############################################################################## external_templates: diff --git a/defaults/both/content_rating_de.yml b/defaults/both/content_rating_de.yml index 8915734f..ca1b9907 100644 --- a/defaults/both/content_rating_de.yml +++ b/defaults/both/content_rating_de.yml @@ -2,7 +2,7 @@ # DE Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_de.html # +# https://metamanager.wiki/en/latest/defaults/both/content_rating_de # ############################################################################## external_templates: diff --git a/defaults/both/content_rating_mal.yml b/defaults/both/content_rating_mal.yml index 145c046a..059091aa 100644 --- a/defaults/both/content_rating_mal.yml +++ b/defaults/both/content_rating_mal.yml @@ -2,7 +2,7 @@ # MAL Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_mal.html # +# https://metamanager.wiki/en/latest/defaults/both/content_rating_mal # ############################################################################## external_templates: diff --git a/defaults/both/content_rating_uk.yml b/defaults/both/content_rating_uk.yml index 7f1f0f04..ab65b928 100644 --- a/defaults/both/content_rating_uk.yml +++ b/defaults/both/content_rating_uk.yml @@ -2,7 +2,7 @@ # UK Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_uk.html # +# https://metamanager.wiki/en/latest/defaults/both/content_rating_uk # ############################################################################## external_templates: diff --git a/defaults/both/genre.yml b/defaults/both/genre.yml index c09b0605..32fef2b3 100644 --- a/defaults/both/genre.yml +++ b/defaults/both/genre.yml @@ -2,7 +2,7 @@ # Genre Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/genre.html # +# https://metamanager.wiki/en/latest/defaults/both/genre # ############################################################################## external_templates: diff --git a/defaults/both/resolution.yml b/defaults/both/resolution.yml index ec0d2250..962e476a 100644 --- a/defaults/both/resolution.yml +++ b/defaults/both/resolution.yml @@ -2,7 +2,7 @@ # Resolution Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/resolution.html # +# https://metamanager.wiki/en/latest/defaults/both/resolution # ############################################################################## external_templates: diff --git a/defaults/both/streaming.yml b/defaults/both/streaming.yml index f59b6ca0..1f0d74ce 100644 --- a/defaults/both/streaming.yml +++ b/defaults/both/streaming.yml @@ -2,7 +2,7 @@ # Streaming Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/streaming.html # +# https://metamanager.wiki/en/latest/defaults/both/streaming # ############################################################################## external_templates: diff --git a/defaults/both/studio.yml b/defaults/both/studio.yml index 0593c0ca..5ec66530 100644 --- a/defaults/both/studio.yml +++ b/defaults/both/studio.yml @@ -2,7 +2,7 @@ # Studio Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/studio.html # +# https://metamanager.wiki/en/latest/defaults/both/studio # ############################################################################## external_templates: diff --git a/defaults/both/subtitle_language.yml b/defaults/both/subtitle_language.yml index f03b326e..ca5fe0f1 100644 --- a/defaults/both/subtitle_language.yml +++ b/defaults/both/subtitle_language.yml @@ -2,7 +2,7 @@ # Subtitle Language Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/subtitle_language.html # +# https://metamanager.wiki/en/latest/defaults/both/subtitle_language # ############################################################################## external_templates: diff --git a/defaults/both/universe.yml b/defaults/both/universe.yml index 580184e4..fa9a8bec 100644 --- a/defaults/both/universe.yml +++ b/defaults/both/universe.yml @@ -2,7 +2,7 @@ # Universe Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/universe.html # +# https://metamanager.wiki/en/latest/defaults/both/universe # ############################################################################## external_templates: @@ -81,12 +81,13 @@ dynamic_collections: fast: movie rocky: movie mummy: movie - # check1 trakt_url: + # check1 mcu: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe trek: https://trakt.tv/users/wdvhucb/lists/star-trek middle: https://trakt.tv/users/oya-kesh/lists/middle-earth mdblist_url: + # check2 avp: https://mdblist.com/lists/plexmetamanager/external/16872 arrow: https://mdblist.com/lists/plexmetamanager/external/15113 dca: https://mdblist.com/lists/plexmetamanager/external/15405 diff --git a/defaults/both/year.yml b/defaults/both/year.yml index 7aaa37e0..637acdaa 100644 --- a/defaults/both/year.yml +++ b/defaults/both/year.yml @@ -2,7 +2,7 @@ # Year Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/year.html # +# https://metamanager.wiki/en/latest/defaults/both/year # ############################################################################## external_templates: diff --git a/defaults/chart/anilist.yml b/defaults/chart/anilist.yml index a0ced1cb..e6e5c4cb 100644 --- a/defaults/chart/anilist.yml +++ b/defaults/chart/anilist.yml @@ -2,7 +2,7 @@ # AniList Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/anilist.html # +# https://metamanager.wiki/en/latest/defaults/chart/anilist # ############################################################################## external_templates: diff --git a/defaults/chart/basic.yml b/defaults/chart/basic.yml index 4b462398..24809715 100644 --- a/defaults/chart/basic.yml +++ b/defaults/chart/basic.yml @@ -2,7 +2,7 @@ # Basic Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/basic.html # +# https://metamanager.wiki/en/latest/defaults/chart/basic # ############################################################################## external_templates: diff --git a/defaults/chart/flixpatrol.yml b/defaults/chart/flixpatrol.yml index 8d6cb861..32fcf9c2 100644 --- a/defaults/chart/flixpatrol.yml +++ b/defaults/chart/flixpatrol.yml @@ -2,7 +2,7 @@ # FlixPatrol Charts Collections # # Created by Yozora, Bullmoose20, anon_fawkes, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/flixpatrol.html # +# https://metamanager.wiki/en/latest/defaults/chart/flixpatrol # ############################################################################## external_templates: diff --git a/defaults/chart/imdb.yml b/defaults/chart/imdb.yml index 116df6a5..87e111b7 100644 --- a/defaults/chart/imdb.yml +++ b/defaults/chart/imdb.yml @@ -2,7 +2,7 @@ # IMDb Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/imdb.html # +# https://metamanager.wiki/en/latest/defaults/chart/imdb # ############################################################################## external_templates: diff --git a/defaults/chart/myanimelist.yml b/defaults/chart/myanimelist.yml index a7a65d18..2195d0df 100644 --- a/defaults/chart/myanimelist.yml +++ b/defaults/chart/myanimelist.yml @@ -2,7 +2,7 @@ # MyAnimeList Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/myanimelist.html # +# https://metamanager.wiki/en/latest/defaults/chart/myanimelist # ############################################################################## external_templates: diff --git a/defaults/chart/other_chart.yml b/defaults/chart/other_chart.yml index be12c6da..c186c1e8 100644 --- a/defaults/chart/other_chart.yml +++ b/defaults/chart/other_chart.yml @@ -2,7 +2,7 @@ # Other Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/other.html # +# https://metamanager.wiki/en/latest/defaults/chart/other # ############################################################################## external_templates: diff --git a/defaults/chart/separator_chart.yml b/defaults/chart/separator_chart.yml index 7b10bf74..6029b04d 100644 --- a/defaults/chart/separator_chart.yml +++ b/defaults/chart/separator_chart.yml @@ -2,7 +2,7 @@ # Chart Separator Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/award/separator_chart.html # +# https://metamanager.wiki/en/latest/defaults/award/separator_chart # ############################################################################## external_templates: diff --git a/defaults/chart/tautulli.yml b/defaults/chart/tautulli.yml index 41798fb4..a6cf0024 100644 --- a/defaults/chart/tautulli.yml +++ b/defaults/chart/tautulli.yml @@ -2,7 +2,7 @@ # Tautulli Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/tautulli.html # +# https://metamanager.wiki/en/latest/defaults/chart/tautulli # ############################################################################## external_templates: diff --git a/defaults/chart/tmdb.yml b/defaults/chart/tmdb.yml index afca610c..78206645 100644 --- a/defaults/chart/tmdb.yml +++ b/defaults/chart/tmdb.yml @@ -2,7 +2,7 @@ # TMDb Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/tmdb.html # +# https://metamanager.wiki/en/latest/defaults/chart/tmdb # ############################################################################## external_templates: diff --git a/defaults/chart/trakt.yml b/defaults/chart/trakt.yml index 59ae2747..f96ca7c0 100644 --- a/defaults/chart/trakt.yml +++ b/defaults/chart/trakt.yml @@ -2,7 +2,7 @@ # Trakt Charts Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/chart/trakt.html # +# https://metamanager.wiki/en/latest/defaults/chart/trakt # ############################################################################## external_templates: diff --git a/defaults/movie/content_rating_us.yml b/defaults/movie/content_rating_us.yml index a93ecd40..d3c14854 100644 --- a/defaults/movie/content_rating_us.yml +++ b/defaults/movie/content_rating_us.yml @@ -2,7 +2,7 @@ # US Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_us.html # +# https://metamanager.wiki/en/latest/defaults/both/content_rating_us # ############################################################################## external_templates: diff --git a/defaults/movie/continent.yml b/defaults/movie/continent.yml index 7ac7011d..937c5d2c 100644 --- a/defaults/movie/continent.yml +++ b/defaults/movie/continent.yml @@ -3,7 +3,7 @@ # Created by Adam Pope, bartolomesorianol, Bullmoose20 & Sohjiro # # Artwork Credit to Duhniel, Bullmoose20, and Wiki Commons # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/continent.html # +# https://metamanager.wiki/en/latest/defaults/movie/continent # ############################################################################## external_templates: diff --git a/defaults/movie/country.yml b/defaults/movie/country.yml index 3f1bb8f6..6c67c23c 100644 --- a/defaults/movie/country.yml +++ b/defaults/movie/country.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Artwork Credit to Duhniel # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/country.html # +# https://metamanager.wiki/en/latest/defaults/movie/country # ############################################################################## external_templates: diff --git a/defaults/movie/decade.yml b/defaults/movie/decade.yml index 98a1fc89..a2d58041 100644 --- a/defaults/movie/decade.yml +++ b/defaults/movie/decade.yml @@ -2,7 +2,7 @@ # Decade Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/decade.html # +# https://metamanager.wiki/en/latest/defaults/movie/decade # ############################################################################## external_templates: diff --git a/defaults/movie/director.yml b/defaults/movie/director.yml index c9f55ce5..5c206cd1 100644 --- a/defaults/movie/director.yml +++ b/defaults/movie/director.yml @@ -2,7 +2,7 @@ # Director Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/director.html # +# https://metamanager.wiki/en/latest/defaults/movie/director # ############################################################################## external_templates: diff --git a/defaults/movie/franchise.yml b/defaults/movie/franchise.yml index 8e889dba..cd499710 100644 --- a/defaults/movie/franchise.yml +++ b/defaults/movie/franchise.yml @@ -2,7 +2,7 @@ # Franchise Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/franchise.html # +# https://metamanager.wiki/en/latest/defaults/movie/franchise # ############################################################################## templates: @@ -98,6 +98,7 @@ dynamic_collections: 535790: Godzilla (Anime) template_variables: movie: + # check1 105995: 336560 # Anaconda: Lake Placid vs. Anaconda 176097: 14177 # Barbershop: Beauty Shop 448150: 567604 # Deadpool: Once Upon a Deadpool @@ -125,6 +126,7 @@ dynamic_collections: 63043: 73362 # TRON: TRON: The Next Day 748: 567604 # X-Men: Once Upon a Deadpool name_mapping: + # check2 1565: 28 Days-Weeks Later 508334: Angels in the 115838: Escape From diff --git a/defaults/movie/producer.yml b/defaults/movie/producer.yml index 54f4735c..a9f35144 100644 --- a/defaults/movie/producer.yml +++ b/defaults/movie/producer.yml @@ -2,7 +2,7 @@ # Producer Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/producer.html # +# https://metamanager.wiki/en/latest/defaults/movie/producer # ############################################################################## external_templates: diff --git a/defaults/movie/region.yml b/defaults/movie/region.yml index 3873994e..697f45d0 100644 --- a/defaults/movie/region.yml +++ b/defaults/movie/region.yml @@ -3,7 +3,7 @@ # Created by Adam Pope, bartolomesorianol, Bullmoose20 & Sohjiro # # Artwork Credit to Duhniel, Bullmoose20, and Wiki Commons # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/region.html # +# https://metamanager.wiki/en/latest/defaults/movie/region # ############################################################################## external_templates: diff --git a/defaults/movie/seasonal.yml b/defaults/movie/seasonal.yml index 0cb325bb..75ad93f7 100644 --- a/defaults/movie/seasonal.yml +++ b/defaults/movie/seasonal.yml @@ -2,7 +2,7 @@ # Seasonal Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/seasonal.html # +# https://metamanager.wiki/en/latest/defaults/movie/seasonal # ############################################################################## external_templates: @@ -102,6 +102,7 @@ dynamic_collections: - arr template_variables: emoji: + # check1 years: "🎊 " valentine: "💘 " patrick: "☘ " @@ -122,6 +123,7 @@ dynamic_collections: women: "🚺 " black_history: "✊ 🏿 " schedule: + # check2 years: range(12/26-01/04) valentine: range(02/01-02/29) patrick: range(03/01-03/18) @@ -142,6 +144,7 @@ dynamic_collections: latinx: range(09/15-10/15) women: range(02/28-03/31) imdb_list: + # check3 years: https://www.imdb.com/list/ls066838460/ valentine: - https://www.imdb.com/list/ls000094398/ @@ -168,10 +171,13 @@ dynamic_collections: - https://www.imdb.com/list/ls091597850/ christmas: https://www.imdb.com/list/ls000096828/ imdb_search: + # check4 women: - - keyword.any: women in film, womens rights, womens suffrage - limit: 500 + keyword.any: women in film, womens rights, womens suffrage + sort_by: rating.desc + limit: 500 tmdb_collection: + # check5 halloween: - 185103 # Hotel Transylvania - 11716 # Addams Family @@ -184,9 +190,11 @@ dynamic_collections: - 2980 # Ghostbusters - 751156 # Hocus Pocus tmdb_movie: + # check6 halloween: - 23437 # A Nightmare on Elm Street (2010) mdblist_list: + # check7 aapi: - https://mdblist.com/lists/plexmetamanager/asian-american-pacific-islander-heritage-month disabilities: @@ -196,6 +204,7 @@ dynamic_collections: latinx: - https://mdblist.com/lists/plexmetamanager/latinx-heritage-month trakt_list: + # check8 black_history: - https://trakt.tv/users/hoochzilla/lists/black-cinema?display=movie&sort=title,asc - https://trakt.tv/users/bluephi8/lists/black-history?display=movie&sort=title,asc diff --git a/defaults/movie/writer.yml b/defaults/movie/writer.yml index 0a21e95b..3227320e 100644 --- a/defaults/movie/writer.yml +++ b/defaults/movie/writer.yml @@ -2,7 +2,7 @@ # Writer Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/movie/writer.html # +# https://metamanager.wiki/en/latest/defaults/movie/writer # ############################################################################## external_templates: diff --git a/defaults/overlays/aspect.yml b/defaults/overlays/aspect.yml index c77289ea..a17661c6 100644 --- a/defaults/overlays/aspect.yml +++ b/defaults/overlays/aspect.yml @@ -2,7 +2,7 @@ # Aspect Ratio Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/aspect.html # +# https://metamanager.wiki/en/latest/defaults/overlays/aspect # ############################################################################## external_templates: diff --git a/defaults/overlays/audio_codec.yml b/defaults/overlays/audio_codec.yml index 3d6993e0..50b1a89c 100644 --- a/defaults/overlays/audio_codec.yml +++ b/defaults/overlays/audio_codec.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/audio_codec.html # +# https://metamanager.wiki/en/latest/defaults/overlays/audio_codec # ############################################################################## external_templates: diff --git a/defaults/overlays/commonsense.yml b/defaults/overlays/commonsense.yml index 3defc578..6b1751cf 100644 --- a/defaults/overlays/commonsense.yml +++ b/defaults/overlays/commonsense.yml @@ -2,7 +2,7 @@ # Commonsense Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/commonsense.html # +# https://metamanager.wiki/en/latest/defaults/overlays/commonsense # ############################################################################## external_templates: diff --git a/defaults/overlays/content_rating_de.yml b/defaults/overlays/content_rating_de.yml index 65b3d29e..0829d1ba 100644 --- a/defaults/overlays/content_rating_de.yml +++ b/defaults/overlays/content_rating_de.yml @@ -2,7 +2,7 @@ # DE Content Rating Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_de.html# +# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_de # ############################################################################## external_templates: diff --git a/defaults/overlays/content_rating_uk.yml b/defaults/overlays/content_rating_uk.yml index 0ebae431..0a03af1f 100644 --- a/defaults/overlays/content_rating_uk.yml +++ b/defaults/overlays/content_rating_uk.yml @@ -2,7 +2,7 @@ # UK Content Rating Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_uk.html# +# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_uk # ############################################################################## external_templates: diff --git a/defaults/overlays/content_rating_us_movie.yml b/defaults/overlays/content_rating_us_movie.yml index a647b78e..89f8bfe5 100644 --- a/defaults/overlays/content_rating_us_movie.yml +++ b/defaults/overlays/content_rating_us_movie.yml @@ -2,7 +2,7 @@ # US Content Rating Movie Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_us_movie.html # +# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_us_movie # ###################################################################################### external_templates: diff --git a/defaults/overlays/content_rating_us_show.yml b/defaults/overlays/content_rating_us_show.yml index 82407838..b53c534e 100644 --- a/defaults/overlays/content_rating_us_show.yml +++ b/defaults/overlays/content_rating_us_show.yml @@ -2,7 +2,7 @@ # US Content Rating Show Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_us_show.html # +# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_us_show # ###################################################################################### external_templates: diff --git a/defaults/overlays/direct_play.yml b/defaults/overlays/direct_play.yml index 96538a8f..a7975624 100644 --- a/defaults/overlays/direct_play.yml +++ b/defaults/overlays/direct_play.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/direct_play.html # +# https://metamanager.wiki/en/latest/defaults/overlays/direct_play # ############################################################################## external_templates: diff --git a/defaults/overlays/episode_info.yml b/defaults/overlays/episode_info.yml index 997e20d0..4feeacd8 100644 --- a/defaults/overlays/episode_info.yml +++ b/defaults/overlays/episode_info.yml @@ -2,7 +2,7 @@ # Episode Info Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/episode_info.html # +# https://metamanager.wiki/en/latest/defaults/overlays/episode_info # ############################################################################## external_templates: diff --git a/defaults/overlays/flixpatrol.yml b/defaults/overlays/flixpatrol.yml index cbcd2598..5fcd567d 100644 --- a/defaults/overlays/flixpatrol.yml +++ b/defaults/overlays/flixpatrol.yml @@ -2,7 +2,7 @@ # FlixPatrol Overlays # # Created by Yozora, Bullmoose20, anon_fawkes, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/flixpatrol.html # +# https://metamanager.wiki/en/latest/defaults/overlays/flixpatrol # ############################################################################## external_templates: diff --git a/defaults/overlays/language_count.yml b/defaults/overlays/language_count.yml index 98adf451..3529a3fc 100644 --- a/defaults/overlays/language_count.yml +++ b/defaults/overlays/language_count.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/language_count.html # +# https://metamanager.wiki/en/latest/defaults/overlays/language_count # ############################################################################## external_templates: diff --git a/defaults/overlays/languages.yml b/defaults/overlays/languages.yml index c9485c3c..0edb9d81 100644 --- a/defaults/overlays/languages.yml +++ b/defaults/overlays/languages.yml @@ -2,7 +2,7 @@ # Audio/Subtitle Language Flags Overlays # # Created by Yozora, Bullmoose20, Cpt Kuesel, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/languages.html # +# https://metamanager.wiki/en/latest/defaults/overlays/languages # ############################################################################## external_templates: diff --git a/defaults/overlays/mediastinger.yml b/defaults/overlays/mediastinger.yml index 7bc6efd9..9bda9c5d 100644 --- a/defaults/overlays/mediastinger.yml +++ b/defaults/overlays/mediastinger.yml @@ -2,7 +2,7 @@ # MediaStinger Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/mediastinger.html # +# https://metamanager.wiki/en/latest/defaults/overlays/mediastinger # ############################################################################## external_templates: diff --git a/defaults/overlays/network.yml b/defaults/overlays/network.yml index 5630bf21..7dd110da 100644 --- a/defaults/overlays/network.yml +++ b/defaults/overlays/network.yml @@ -2,7 +2,7 @@ # Network Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/network.html # +# https://metamanager.wiki/en/latest/defaults/overlays/network # ############################################################################## external_templates: diff --git a/defaults/overlays/ratings.yml b/defaults/overlays/ratings.yml index 9b0ebb1e..1bf47a92 100644 --- a/defaults/overlays/ratings.yml +++ b/defaults/overlays/ratings.yml @@ -2,7 +2,7 @@ # Ratings Overlays # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/ratings.html # +# https://metamanager.wiki/en/latest/defaults/overlays/ratings # ############################################################################## templates: diff --git a/defaults/overlays/resolution.yml b/defaults/overlays/resolution.yml index f791d43a..dc19d53b 100644 --- a/defaults/overlays/resolution.yml +++ b/defaults/overlays/resolution.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/resolution.html # +# https://metamanager.wiki/en/latest/defaults/overlays/resolution # ############################################################################## external_templates: diff --git a/defaults/overlays/ribbon.yml b/defaults/overlays/ribbon.yml index 1152fcf5..6899b5da 100644 --- a/defaults/overlays/ribbon.yml +++ b/defaults/overlays/ribbon.yml @@ -2,7 +2,7 @@ # Ribbon Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/ribbon.html # +# https://metamanager.wiki/en/latest/defaults/overlays/ribbon # ############################################################################## external_templates: @@ -50,71 +50,138 @@ overlays: Oscars Best Picture: variables: {key: oscars, weight: 180} template: {name: standard, allowed_libraries: movie} - imdb_search: - event.winning: oscar_picture + imdb_award: + event_id: ev0000003 + event_year: all + category_filter: + - best picture + - best motion picture of the year + winning: true Oscars Best Director: variables: {key: oscars_director, weight: 170} template: {name: standard, allowed_libraries: movie} - imdb_search: - event.winning: oscar_director + imdb_award: + event_id: ev0000003 + event_year: all + category_filter: + - best achievement in directing + - best director + - best director, comedy picture + - best director, dramatic picture + winning: true Golden Globe Winner: variables: {key: golden, weight: 160} template: [name: standard, name: ribbon] - imdb_search: - event.winning: golden + imdb_award: + event_id: ev0000292 + event_year: all + category_filter: + - best motion picture - animated + - best motion picture - comedy + - best motion picture - comedy or musical + - best motion picture - drama + - best motion picture - foreign language + - best motion picture - musical + - best motion picture - musical or comedy + - best motion picture - non-english language + - best motion picture, animated + - best motion picture, drama + - best motion picture, musical or comedy + - best motion picture, non-english language + winning: true Golden Globe Best Director: variables: {key: golden_director, weight: 150} template: {name: standard, allowed_libraries: movie} - tmdb_list: https://www.themoviedb.org/list/8235502 + imdb_award: + event_id: ev0000292 + event_year: all + category_filter: + - best director + - best director - motion picture + - best director, motion picture + winning: true BAFTA Winners: variables: {key: bafta, weight: 140} template: {name: standard, allowed_libraries: movie} - trakt_list: https://trakt.tv/users/maxwelldeux/lists/bafta-award-best-film + imdb_award: + event_id: ev0000123 + event_year: all + category_filter: best film + winning: true Cannes Winners: variables: {key: cannes, weight: 130} template: {name: standard, allowed_libraries: movie} - trakt_list: https://trakt.tv/users/maxwelldeux/lists/cannes-film-festival-palme-d-or + imdb_award: + event_id: ev0000147 + event_year: all + award_filter: palme d'or + winning: true Berlinale Winners: variables: {key: berlinale, weight: 120} template: {name: standard, allowed_libraries: movie} - trakt_list: https://trakt.tv/users/maxwelldeux/lists/berlin-international-film-festival-golden-bears + imdb_award: + event_id: ev0000091 + event_year: all + category_filter: best film + winning: true Venice Winners: variables: {key: venice, weight: 110} template: {name: standard, allowed_libraries: movie} - trakt_list: https://trakt.tv/users/maxwelldeux/lists/venice-film-festival-golden-lion + imdb_award: + event_id: ev0000681 + event_year: all + award_filter: golden lion + winning: true Sundance Winners: variables: {key: sundance, weight: 100} template: {name: standard, allowed_libraries: movie} - trakt_list: https://trakt.tv/users/maxwelldeux/lists/sundance-film-festival-grand-jury-prize + imdb_award: + event_id: ev0000631 + event_year: all + award_filter: grand jury prize + winning: true Emmys Winner: variables: {key: emmys, weight: 90} template: [name: standard, name: ribbon] imdb_search: event.winning: emmy + limit: 1000 Critics Choice Winners: variables: {key: choice, weight: 80} template: {name: standard, allowed_libraries: movie} - mdblist_list: https://mdblist.com/lists/plexmetamanager/critics-choice + imdb_award: + event_id: ev0000133 + event_year: all + category_filter: best picture + winning: true Spirit Winners: variables: {key: spirit, weight: 70} template: {name: standard, allowed_libraries: movie} - mdblist_list: https://mdblist.com/lists/plexmetamanager/independent-spirit + imdb_award: + event_id: ev0000349 + event_year: all + category_filter: best feature + winning: true Cesar Winners: variables: {key: cesar, weight: 60} template: {name: standard, allowed_libraries: movie} - trakt_list: https://trakt.tv/users/maxwelldeux/lists/cesar-award-best-french-film + imdb_award: + event_id: ev0000157 + event_year: all + category_filter: best film (meilleur film) + winning: true IMDb Top 250: variables: {key: imdb, weight: 50, imdb_key: top} @@ -135,5 +202,8 @@ overlays: Razzies Winner: variables: {key: razzie, weight: 10} template: {name: standard, allowed_libraries: movie} - imdb_search: - event.winning: razzie + imdb_award: + event_id: ev0000558 + event_year: all + category_filter: worst picture + winning: true diff --git a/defaults/overlays/runtimes.yml b/defaults/overlays/runtimes.yml index 7ad92dfe..f02b969f 100644 --- a/defaults/overlays/runtimes.yml +++ b/defaults/overlays/runtimes.yml @@ -2,7 +2,7 @@ # Runtimes Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/runtimes.html # +# https://metamanager.wiki/en/latest/defaults/overlays/runtimes # ############################################################################## external_templates: diff --git a/defaults/overlays/status.yml b/defaults/overlays/status.yml index 98a9abac..bdb3dbff 100644 --- a/defaults/overlays/status.yml +++ b/defaults/overlays/status.yml @@ -2,7 +2,7 @@ # Status Overlay # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/status.html # +# https://metamanager.wiki/en/latest/defaults/overlays/status # ############################################################################## external_templates: diff --git a/defaults/overlays/streaming.yml b/defaults/overlays/streaming.yml index 64fd4d0e..2fde92ba 100644 --- a/defaults/overlays/streaming.yml +++ b/defaults/overlays/streaming.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/streaming.html # +# https://metamanager.wiki/en/latest/defaults/overlays/streaming # ############################################################################## external_templates: diff --git a/defaults/overlays/studio.yml b/defaults/overlays/studio.yml index 22684c89..ed43167c 100644 --- a/defaults/overlays/studio.yml +++ b/defaults/overlays/studio.yml @@ -2,7 +2,7 @@ # Studio Overlay # # Created by Yozora, Bullmoose20, anon_fawkes Arial-Z & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/studios.html # +# https://metamanager.wiki/en/latest/defaults/overlays/studios # ############################################################################## external_templates: diff --git a/defaults/overlays/versions.yml b/defaults/overlays/versions.yml index b8660549..5b2cda9c 100644 --- a/defaults/overlays/versions.yml +++ b/defaults/overlays/versions.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/versions.html # +# https://metamanager.wiki/en/latest/defaults/overlays/versions # ############################################################################## external_templates: diff --git a/defaults/overlays/video_format.yml b/defaults/overlays/video_format.yml index ab5fc5c5..75c0dadb 100644 --- a/defaults/overlays/video_format.yml +++ b/defaults/overlays/video_format.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Credit to Magic815 for base images # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/overlays/video_format.html # +# https://metamanager.wiki/en/latest/defaults/overlays/video_format # ############################################################################## external_templates: diff --git a/defaults/playlist.yml b/defaults/playlist.yml index d254c381..0c6cea31 100644 --- a/defaults/playlist.yml +++ b/defaults/playlist.yml @@ -2,7 +2,7 @@ # Playlists # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/playlist.html # +# https://metamanager.wiki/en/latest/defaults/playlist # ############################################################################## external_templates: @@ -10,6 +10,27 @@ external_templates: templates: playlist: + conditionals: + trakt_list: + conditions: + - key: arrow + value: https://trakt.tv/users/donxy/lists/arrowverse + - key: mcu + value: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe + - key: dcau + value: https://trakt.tv/users/donxy/lists/dc-animated-series-universe + - key: pokemon + value: https://trakt.tv/users/munch54/lists/pokemon-watching-order + - key: startrek + value: https://trakt.tv/users/goodevilgenius/lists/star-trek-chronology + - key: starwars + value: https://trakt.tv/users/xrayblaster/lists/star-wars-chronological-order + - key: clonewars + value: https://trakt.tv/users/tomfin46/lists/star-wars-the-clone-wars-chronological-episode-order + - key: xmen + value: https://trakt.tv/users/heyitsbea/lists/x-men + - key: dragonball + value: https://trakt.tv/users/grawler/lists/dragon-ball-in-order default: libraries: Movies, TV Shows item_radarr_tag_<>: <> @@ -52,7 +73,6 @@ playlists: key: arrow template: - name: playlist - trakt_list: https://trakt.tv/users/donxy/lists/arrowverse summary_arrow: The Arrowverse is an American superhero media franchise and a shared universe that is centered on various interconnected television series based on DC Comics superhero characters, primarily airing on The CW as well as web series on CW Seed. - name: arr @@ -61,7 +81,6 @@ playlists: key: mcu template: - name: playlist - trakt_list: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe summary_mcu: The Marvel Cinematic Universe (MCU) is a collection of movies and television series that tell a singular narrative related to Marvel characters, settings and stories. The MCU is a product from Disney and Marvel that brings us heroes from Black Panther and Doctor Strange to Spider-Man and Iron Man. - name: arr @@ -79,7 +98,6 @@ playlists: key: pokemon template: - name: playlist - trakt_list: https://trakt.tv/users/munch54/lists/pokemon-watching-order summary_pokemon: Ash Ketchum, his yellow pet Pikachu, and his human friends explore a world of powerful creatures. Ten-year-old Ash aspires to be the greatest Pokémon (pocket monster) trainer in the world. To do this, he enlists the help of many friends, and his own Pokémon, Pikachu. - name: arr @@ -88,7 +106,6 @@ playlists: key: startrek template: - name: playlist - trakt_list: https://trakt.tv/users/goodevilgenius/lists/star-trek-chronology summary_startrek: All Star Trek canon in chronological order, as found on thestartrekchronologyproject.blogspot.com. Includes animated series. Will be updated with new shows as they come out. Does not include Kelvinverse movies. - name: arr @@ -97,7 +114,6 @@ playlists: key: starwars template: - name: playlist - trakt_list: https://trakt.tv/users/xrayblaster/lists/star-wars-chronological-order summary_starwars: A long time ago in a galaxy far, far away, a farm boy on a desert planet dreamed of joining a rebellion and saving a princess from a dark lord, and thus, one of the most successful cinematic sagas of all time was born. What began with one space opera in 1977 quickly grew into a media empire that included toys, comic books, video games, TV series, and memorabilia in every possible form. Today, more than 40 years after it first arrived, Star Wars remains a global pop culture phenomenon, and the story still isn't over. - name: arr @@ -106,7 +122,6 @@ playlists: key: clonewars template: - name: playlist - trakt_list: https://trakt.tv/users/tomfin46/lists/star-wars-the-clone-wars-chronological-episode-order summary_clonewars: As more star systems get swept into the Clone Wars, the valiant Jedi knights struggle to maintain order. Anakin Skywalker and his Padawan learner Ahsoka Tano embark on a mission that brings them face-to-face with Jabba the Hutt. Plotting against them is evil Count Dooku and his agent, Asajj Ventress, who would ensure that the Jedis fail. Meanwhile, Yoda and Obi-Wan Kenobi lead the clone army against the forces of the Dark Side. - name: arr @@ -115,7 +130,6 @@ playlists: key: xmen template: - name: playlist - trakt_list: https://trakt.tv/users/heyitsbea/lists/x-men summary_xmen: The X-Men are a fictional team of superheroes appearing in American comic books published by Marvel Comics, first appearing in The X-Men Issue 1. Although initially cancelled in 1970, following its 1975 revival and subsequent direction under writer Chris Claremont, it became one of the most recognizable and successful franchises of Marvel Comics. - name: arr @@ -124,6 +138,5 @@ playlists: key: dragonball template: - name: playlist - trakt_list: https://trakt.tv/users/grawler/lists/dragon-ball-in-order summary_dragonball: Dragon Ball follows the adventures of an extraordinarily strong young boy named Goku as he searches for the seven dragon balls. These balls, when combined, can grant the owner any one wish he desires. Along the way he makes many new friends, and enemies, and he trains to become the strongest fighter in the world. - name: arr diff --git a/defaults/show/content_rating_us.yml b/defaults/show/content_rating_us.yml index bd941603..52415b76 100644 --- a/defaults/show/content_rating_us.yml +++ b/defaults/show/content_rating_us.yml @@ -2,7 +2,7 @@ # US Content Rating Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/both/content_rating_us.html # +# https://metamanager.wiki/en/latest/defaults/both/content_rating_us # ############################################################################## external_templates: diff --git a/defaults/show/continent.yml b/defaults/show/continent.yml index 71fcb0d2..d55db1b8 100644 --- a/defaults/show/continent.yml +++ b/defaults/show/continent.yml @@ -3,7 +3,7 @@ # Created by Adam Pope, bartolomesorianol, Bullmoose20 & Sohjiro # # Artwork Credit to Duhniel, Bullmoose20, and Wiki Commons # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/continent.html # +# https://metamanager.wiki/en/latest/defaults/show/continent # ############################################################################## external_templates: diff --git a/defaults/show/country.yml b/defaults/show/country.yml index 966f8e65..62c8836c 100644 --- a/defaults/show/country.yml +++ b/defaults/show/country.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Artwork Credit to Duhniel # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/country.html # +# https://metamanager.wiki/en/latest/defaults/show/country # ############################################################################## external_templates: diff --git a/defaults/show/decade.yml b/defaults/show/decade.yml index 06853b6f..a6e70bf1 100644 --- a/defaults/show/decade.yml +++ b/defaults/show/decade.yml @@ -2,7 +2,7 @@ # Decade Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/decade.html # +# https://metamanager.wiki/en/latest/defaults/show/decade # ############################################################################## external_templates: diff --git a/defaults/show/franchise.yml b/defaults/show/franchise.yml index 1be1fa55..23bead35 100644 --- a/defaults/show/franchise.yml +++ b/defaults/show/franchise.yml @@ -3,7 +3,7 @@ # Created by Yozora, Bullmoose20, & Sohjiro # # Additional contributions by the PMM Community # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/franchise.html # +# https://metamanager.wiki/en/latest/defaults/show/franchise # ############################################################################## templates: diff --git a/defaults/show/network.yml b/defaults/show/network.yml index 88eb3631..c5995ac4 100644 --- a/defaults/show/network.yml +++ b/defaults/show/network.yml @@ -2,7 +2,7 @@ # Network Collections # # Created by Yozora, Bullmoose20, & Sohjiro # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/network.html # +# https://metamanager.wiki/en/latest/defaults/show/network # ############################################################################## external_templates: diff --git a/defaults/show/region.yml b/defaults/show/region.yml index 7bf2541b..9fe3ceb5 100644 --- a/defaults/show/region.yml +++ b/defaults/show/region.yml @@ -3,7 +3,7 @@ # Created by Adam Pope, bartolomesorianol, Bullmoose20 & Sohjiro # # Artwork Credit to Duhniel, Bullmoose20, and Wiki Commons # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # -# https://metamanager.wiki/en/latest/defaults/show/region.html # +# https://metamanager.wiki/en/latest/defaults/show/region # ############################################################################## external_templates: diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index d2c7a65b..a6ac6745 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -45,18 +45,18 @@ work. Any value not specified will use its default value if it has one if not it Be sure to also check out the "Shared Template Variables" tab for additional variables. - | Variable | Description & Values | - |:---------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `use_year_collections` | **Description:** Turn the individual year collections off.
**Values:** `false` to turn of the collections | - | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| - | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `BAFTA <>`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<> BAFTA Awards.`
**Values:** Any string with `<>` in it. | + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.
**Values:** `false` to turn of the collections | + | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `BAFTA <>`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<> BAFTA Awards.`
**Values:** Any string with `<>` in it. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index 721f344a..c6533c72 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -48,8 +48,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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
| | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Cannes <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index 6307870c..785e4546 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -14,6 +14,7 @@ Requirements: [Trakt Authentication](../../config/trakt.md) | Collection | Key | Description | |:------------------------------------------------------------------------------|:----------------------------------|:---------------------------------------------------------------| +| `Critics Choice Best Picture Winners` | `best` | Collection of Critics Choice Best Feature Award Winners | | `Critics Choice Awards <>`
**Example:** `Critics Choice Awards 2022` | `<>`
**Example:** `2022` | Collection of Critics Choice Award Winners for the given year. | ## Config @@ -50,8 +51,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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
| | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Critics Choice <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index eea581b8..ce06ba54 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -42,15 +42,14 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | Variable | Description & Values | |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off.
**Values:** `false` to turn off the collections | | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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
| | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Emmys <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index 8cd300a3..759cb725 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -46,15 +46,14 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | Variable | Description & Values | |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off.
**Values:** `false` to turn of the collections | | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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
| | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Golden Globe <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index 83ac2a9b..53ae3f85 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -41,15 +41,14 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | Variable | Description & Values | |:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off.
**Values:** `false` to turn of the collections | | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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
| | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-6
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year-1
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Oscars Winners <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md index 6306bb63..810babd7 100644 --- a/docs/defaults/award/other.md +++ b/docs/defaults/award/other.md @@ -45,12 +45,12 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | 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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | 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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index a63093a1..b092c404 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -14,6 +14,7 @@ Requirements: [Trakt Authentication](../../config/trakt.md) | Collection | Key | Description | |:--------------------------------------------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------| +| `Spirit Best Feature Winners` | `best` | Collection of Independent Spirit Best Feature Award Winners. | | `Independent Spirit Awards <>`
**Example:** `Independent Spirit Awards 2022` | `<>`
**Example:** `2022` | Collection of Independent Spirit Award Winners for the given year. | ## Config @@ -41,15 +42,14 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | Variable | Description & Values | |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off.
**Values:** `false` to turn of the collections | | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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
| | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Independent Spirit Awards <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index 7e19e5df..47987232 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -48,8 +48,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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
| | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Sundance Film Festival <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index ee885bb1..2b600274 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -53,8 +53,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `style` | **Description:** Controls the visual theme of the collections created.
**Default:** `bw`
**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Default: 5
Values: Number greater than 0
limitControls the maximum number of collections to create
Default: 25
Values: Number greater than 0
| | `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.
**Values:** List of Actor Names | | `exclude` | **Description:** Exclude these Actors from creating a Dynamic Collection.
**Values:** List of Actor Names | diff --git a/docs/defaults/both/aspect.md b/docs/defaults/both/aspect.md index bb547c06..c8da3bcd 100644 --- a/docs/defaults/both/aspect.md +++ b/docs/defaults/both/aspect.md @@ -52,19 +52,20 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:--------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.
**Values:** List of Media Outlet Keys | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Based on a <>`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s based on or inspired by <>s.`
**Values:** Any string. | - -1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. + | Variable | Description & Values | + |:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.
**Values:** List of Media Outlet Keys | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Based on a <>`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s based on or inspired by <>s.`
**Values:** Any string. | + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. + === "Shared Template Variables" {% diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index 9c85bad7..0bb474c5 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -50,12 +50,13 @@ Note that the `template_variables:` section only needs to be used if you do want |:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | + | `append_include` | **Description:** Appends to the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | + | `remove_include` | **Description:** Removes from the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | - | `append_include` | **Description:** Appends to the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | - | `remove_include` | **Description:** Removes from the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | + | `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).
**Values:** Dictionary with `key: new_key_name` entries | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> Audio`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in the <> Language.`
**Values:** Any string. | @@ -96,7 +97,7 @@ Note that the `template_variables:` section only needs to be used if you do want 2. Do not create an "Audio Language Collections" separator 3. Exclude "French" from having an Audio Collection -## Default values +## Default Values These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** diff --git a/docs/defaults/both/based.md b/docs/defaults/both/based.md index e1d5d2dd..a0bf11f0 100644 --- a/docs/defaults/both/based.md +++ b/docs/defaults/both/based.md @@ -48,17 +48,17 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:--------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.
**Values:** List of Media Outlet Keys | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Based on a <>`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s based on or inspired by <>s.`
**Values:** Any string. | + | Variable | Description & Values | + |:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.
**Values:** List of Media Outlet Keys | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Based on a <>`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s based on or inspired by <>s.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/both/collectionless.md b/docs/defaults/both/collectionless.md index 31cbfbc3..95988f1d 100644 --- a/docs/defaults/both/collectionless.md +++ b/docs/defaults/both/collectionless.md @@ -12,9 +12,9 @@ Requirements: For this file to work it needs to run last under `collection_files ## Collection -| Collection | Description | -|:-----------------|:------------------------------------------------------------------------------------------------------------------------------------------| -| `Collectionless` | [Collectionless collection](../../files/builders/plex.md#plex-collectionless) to help Show/Hide Movies/Shows properly in your library.. | +| Collection | Description | +|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------| +| `Collectionless` | [Collectionless collection](../../files/builders/plex.md#plex-collectionless) to help Show/Hide Movies/Shows properly in your library. | ## Config @@ -42,15 +42,15 @@ Note that the `template_variables:` section only needs to be used if you do want **[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.** -| Variable | Description & Values | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `name_collectionless` | **Description:** Changes the name of the collection.
**Values:** New Collection Name | -| `summary_collectionless` | **Description:** Changes the summary of the collection.
**Values:** New Collection Summary | -| `sort_title` | **Description:** Sets the sort title for the collection.
**Default:** `~_Collectionless`
**Values:** Any String | -| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**Default:** `alpha`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `url_poster` | **Description:** Changes the poster url of thecollection.
**Values:** URL directly to the Image | -| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.
**Values:** List of Collections | -| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#default-exclude_prefix). Exclude Collections with one of these prefixes from being considered for collectionless.
**Default:** [default exclude_prefix list](#default-exclude_prefix)
**Values:** List of Prefixes | | +| Variable | Description & Values | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `name_collectionless` | **Description:** Changes the name of the collection.
**Values:** New Collection Name | +| `summary_collectionless` | **Description:** Changes the summary of the collection.
**Values:** New Collection Summary | +| `sort_title` | **Description:** Sets the sort title for the collection.
**Default:** `~_Collectionless`
**Values:** Any String | +| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**Default:** `alpha`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `url_poster` | **Description:** Changes the poster url of the collection.
**Values:** URL directly to the Image | +| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.
**Values:** List of Collections | +| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#default-exclude_prefix). Exclude Collections with one of these prefixes from being considered for collectionless.
**Default:** [default exclude_prefix list](#default-exclude_prefix)
**Values:** List of Prefixes | | ### Example Template Variable Amendments @@ -69,7 +69,7 @@ libraries: collection_order: release ``` -## Default values +## Default Values ???+ tip diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index 88d460c2..1dab5bfd 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -50,21 +50,21 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Age <>+ <>s`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <> accorfing to the Common Sense Rating System.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Age <>+ <>s`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <> accorfing to the Common Sense Rating System.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -106,15 +106,15 @@ Note that the `template_variables:` section only needs to be used if you do want 3. Defines a collection which will be called "German 18", this does not need to already exist in your library 4. Adds the "de/18" content rating to the "German 18" addon list, "de/18" must exist in your library if the "German 18" content rating does not -## Default values +## Default Values -??? warning +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`:** +
```yaml include: {% @@ -126,7 +126,9 @@ Note that the `template_variables:` section only needs to be used if you do want %} ``` - **Default `addons`:** +??? example "Default `addons` (click to expand) " + +
```yaml addons: {% @@ -135,4 +137,4 @@ Note that the `template_variables:` section only needs to be used if you do want preserve-includer-indent=false start="addons:" %} - ``` \ No newline at end of file + ``` diff --git a/docs/defaults/both/content_rating_de.md b/docs/defaults/both/content_rating_de.md index 7994a5f0..c785cd6c 100644 --- a/docs/defaults/both/content_rating_de.md +++ b/docs/defaults/both/content_rating_de.md @@ -51,21 +51,21 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -106,15 +106,15 @@ Note that the `template_variables:` section only needs to be used if you do want 3. Defines a collection which will be called "BPjM", this does not need to already exist in your library 4. Adds the "X" content rating to the "BPjM" addon list, "X" must exist in your library if the "BPjM" content rating does not -## Default values +## Default Values -??? warning +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`:** +
```yaml include: {% @@ -126,7 +126,9 @@ Note that the `template_variables:` section only needs to be used if you do want %} ``` - **Default `addons`:** +??? example "Default `addons` (click to expand) " + +
```yaml addons: {% diff --git a/docs/defaults/both/content_rating_mal.md b/docs/defaults/both/content_rating_mal.md index 3de40e10..8457c17b 100644 --- a/docs/defaults/both/content_rating_mal.md +++ b/docs/defaults/both/content_rating_mal.md @@ -50,21 +50,21 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -105,15 +105,15 @@ The below is an example config.yml extract with some Template Variables added in 3. Defines a collection which will be called "R+ - Mild Nudity", this does not need to already exist in your library 4. Adds the "de/18" content rating to the "R+ - Mild Nudity" addon list, "de/18" must exist in your library if the "R+ - Mild Nudity" content rating does not -## Default values +## Default Values -??? tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`:** +
```yaml include: {% @@ -125,7 +125,9 @@ The below is an example config.yml extract with some Template Variables added in %} ``` - **Default `addons`:** +??? example "Default `addons` (click to expand) " + +
```yaml addons: {% diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index cb564133..ced9125b 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -50,21 +50,21 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -105,15 +105,15 @@ Note that the `template_variables:` section only needs to be used if you do want 3. Defines a collection which will be called "15", this does not need to already exist in your library 4. Adds the "de/15" content rating to the "15" addon list, "de/18" must exist in your library if the "15" content rating does not -## Default values +## Default Values -??? tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`:** +
```yaml include: {% @@ -125,7 +125,9 @@ Note that the `template_variables:` section only needs to be used if you do want %} ``` - **Default `addons`:** +??? example "Default `addons` (click to expand) " + +
```yaml addons: {% diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index b67b3915..5908869f 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -47,18 +47,18 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.
**Values:** List of Genres found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Genres found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Genres found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Genres found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the genre <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.
**Values:** List of Genres found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Genres found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Genres found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Genres found in your library | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the genre <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -101,15 +101,15 @@ Note that the `template_variables:` section only needs to be used if you do want 4. Create a "Horror" collection, this genre does not need to exist in your library 5. Include the "Thriller" genre in the "Horror" collection, the "Thriller" genre must exist in your library if the "Horror" genre does not -## Default values +## Default Values -???+ tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `addons` (click to expand) " - **Default `addons`:** +
```yaml addons: {% diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index 95888a62..d752da80 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -53,22 +53,22 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `style` | **Description:** Controls the visual theme of the collections created.
Values:
defaultDefault Theme
standardsStandards Theme
| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** Any Resolutions found in your library | - | `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.
**Values:** List of Resolutions found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Resolutions found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Resolutions found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Resolutions found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Resolutions found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Resolutions found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the resolution <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `style` | **Description:** Controls the visual theme of the collections created.
Values:
defaultDefault Theme
standardsStandards Theme
| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** Any Resolutions found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Resolutions found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Resolutions found in your library | + | `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.
**Values:** List of Resolutions found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Resolutions found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Resolutions found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Resolutions found in your library | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the resolution <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -105,15 +105,15 @@ Note that the `template_variables:` section only needs to be used if you do want 1. Use the green [Separator Style](../separators.md#separator-styles) 2. Do not use the "sd" resolution as part of the "480p Movies/Shows" Collections -## Default values +## Default Values -??? tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`:** +
```yaml include: {% @@ -125,7 +125,9 @@ Note that the `template_variables:` section only needs to be used if you do want %} ``` - **Default `addons`:** +??? example "Default `addons` (click to expand) " + +
```yaml addons: {% diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index 99a378a1..926c34ec 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -65,8 +65,8 @@ Note that the `template_variables:` section only needs to be used if you do want |:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | | `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
| | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.
**Values:** List of Streaming Service Keys | diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index 7035b908..11382195 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -47,21 +47,21 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Studios found in your library | - | `exclude` | **Description:** Exclude these Studios from creating a Dynamic Collection.
**Values:** List of Studios found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Studios found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Studios found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Studios found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Studios found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Studios found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the resolution <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** List of Studios found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Studios found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Studios found in your library | + | `exclude` | **Description:** Exclude these Studios from creating a Dynamic Collection.
**Values:** List of Studios found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Studios found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Studios found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Studios found in your library | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that have the resolution <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -100,15 +100,15 @@ Note that the `template_variables:` section only needs to be used if you do want 2. Show these collections and their items within the "Library" tab 3. Use the gray [Separator Style](../separators.md#separator-styles) -## Default values +## Default Values -??? tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`:** +
```yaml include: {% @@ -120,7 +120,9 @@ Note that the `template_variables:` section only needs to be used if you do want %} ``` - **Default `addons`:** +??? example "Default `addons` (click to expand) " + +
```yaml addons: {% diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index dcc49945..23161c29 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -50,12 +50,13 @@ Note that the `template_variables:` section only needs to be used if you do want |:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | - | `append_include` | **Description:** Appends to the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | - | `remove_include` | **Description:** Removes from the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | + | `append_include` | **Description:** Appends to the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | + | `remove_include` | **Description:** Removes from the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | + | `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).
**Values:** Dictionary with `key: new_key_name` entries | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> Subtitles`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s with <> Subtitles.`
**Values:** Any string. | @@ -97,15 +98,15 @@ Note that the `template_variables:` section only needs to be used if you do want 2. Do not create an "Audio Language Collections" separator 3. Exclude "French" from having an Audio Collection -## Default values +## Default Values -??? tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`:** +
```yaml include: {% @@ -117,7 +118,9 @@ Note that the `template_variables:` section only needs to be used if you do want %} ``` - **Default `key_name_override`:** +??? example "Default `key_name_override` (click to expand) " + +
```yaml key_name_override: {% diff --git a/docs/defaults/both/universe.md b/docs/defaults/both/universe.md index 4f5b825f..ffde0cab 100644 --- a/docs/defaults/both/universe.md +++ b/docs/defaults/both/universe.md @@ -59,20 +59,21 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | 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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | - | `name_mapping_<>`1 | **Description:** Sets the name mapping value for using assets of the specified key's collection.
**Values:** Any String | - | `imdb_list_<>`1 | **Description:** Adds the Movies in the IMDb List to the specified key's collection.
**Values:** List of IMDb List URLs | | | - | `mdblist_list_<>`1 | **Description:** Adds the Movies in the MDBList List to the specified key's collection. Overrides the [default mdblist_list](#default-mdblist_list) for that collection if used.
**Values:** List of MDBList List URLs | | | | - | `trakt_list_<>`1 | **Description:** Adds the Movies in the Trakt List to the specified key's collection.
**Values:** List of Trakt List URLs | | | | - | `data` | **Description:** Overrides the [default data dictionary](#default-data). Defines the data that the custom dynamic collection processes.
**Values:** Dictionary List of keys/names | - | `append_data` | **Description:** Appends to the [default data dictionary](#default-data).
**Values:** Dictionary List of keys/names | - | `exclude` | **Description:** Exclude these Universes from creating a Dynamic Collection.
**Values:** List of Universes | + | 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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | + | `name_mapping_<>`1 | **Description:** Sets the name mapping value for using assets of the specified key's collection.
**Values:** Any String | + | `imdb_list_<>`1 | **Description:** Adds the Movies in the IMDb List to the specified key's collection.
**Values:** List of IMDb List URLs | | | + | `mdblist_list_<>`1 | **Description:** Adds the Movies in the MDBList List to the specified key's collection. Overrides the [default mdblist_url](#mdblist-url) for that collection if used.
**Values:** List of MDBList List URLs | | | | + | `trakt_list_<>`1 | **Description:** Adds the Movies in the Trakt List to the specified key's collection. Overrides the [default trakt_url](#trakt-url) for that collection if used.
**Values:** List of Trakt List URLs | | | | + | `data` | **Description:** Overrides the [default data dictionary](#data). Defines the data that the custom dynamic collection processes.
**Values:** Dictionary List of keys/names | + | `append_data` | **Description:** Appends to the [default data dictionary](#data).
**Values:** Dictionary List of keys/names | + | `remove_data` | **Description:** Removes from the [default data dictionary](#data).
**Values:** List of keys to remove | + | `exclude` | **Description:** Exclude these Universes from creating a Dynamic Collection.
**Values:** List of Universes | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -115,15 +116,15 @@ Note that the `template_variables:` section only needs to be used if you do want 4. Create a new universe called "MonsterVerse", the key for this universe will be "monster" 5. Add a trakt list to the "monster" key -## Default values +## Default Values -??? tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `data` (click to expand) " - **Default `data`:** +
```yaml data: {% @@ -135,15 +136,30 @@ Note that the `template_variables:` section only needs to be used if you do want %} ``` - **Default `mdblist_list`:** +??? example "Default Template Variable`trakt_url` (click to expand) " + +
```yaml - data: {% + trakt_url: {% include-markdown "../../../defaults/both/universe.yml" comments=false preserve-includer-indent=false start="# check1" - end="image:" + end="mdblist_url:" %} ``` +??? example "Default Template Variable`mdblist_url` (click to expand) " + +
+ + ```yaml + mdblist_url: {% + include-markdown "../../../defaults/both/universe.yml" + comments=false + preserve-includer-indent=false + start="# check2" + end="image:" + %} + ``` diff --git a/docs/defaults/both/year.md b/docs/defaults/both/year.md index b5194e0e..86dd2f18 100644 --- a/docs/defaults/both/year.md +++ b/docs/defaults/both/year.md @@ -43,18 +43,18 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. -This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. -| Variable | Description & Values | -|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Number Greater than 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | -| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | -| `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | -| `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-10
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| -| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | + | Variable | Description & Values | + |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-10
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | -1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. === "Shared Template Variables" @@ -91,17 +91,17 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari That's a tooltip, you can press them to get more information. -```yaml -libraries: - Movies: - collection_files: - - pmm: year - template_variables: - sep_style: purple #(1)! - sort_by: title.asc - sort_by_2022: release.desc #(2)! -``` + ```yaml + libraries: + Movies: + collection_files: + - pmm: year + template_variables: + sep_style: purple #(1)! + sort_by: title.asc + sort_by_2022: release.desc #(2)! + ``` -1. Use the purple [Separator Style](../separators.md#separator-styles) -2. Set the sort order for "Best of 2022" to release date descending + 1. Use the purple [Separator Style](../separators.md#separator-styles) + 2. Set the sort order for "Best of 2022" to release date descending diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md index 1198d809..3762fd92 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -45,14 +45,14 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | 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 | - | `limit_<>`1 | **Description:** Changes the number of items in a collection of the specified key's collection.
**Default:** `limit`
**Values:** Number greater than 0 | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | 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 | + | `limit_<>`1 | **Description:** Changes the number of items in a collection of the specified key's collection.
**Default:** `limit`
**Values:** Number greater than 0 | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index 8b8adbcb..02b485c2 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -47,8 +47,8 @@ Note that the `template_variables:` section only needs to be used if you do want |:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.
**Values:** Number greater than 0 | | `limit_<>`1 | **Description:** Changes the Smart Filter Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | | `in_the_last_<>`1 | **Description:** Changes how far back the Smart Filter looks.
**Default:**
`released``90`
`episodes``7`
**Values:** Number greater than 0 | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/flixpatrol.md b/docs/defaults/chart/flixpatrol.md index f3b1f7d3..a33db040 100644 --- a/docs/defaults/chart/flixpatrol.md +++ b/docs/defaults/chart/flixpatrol.md @@ -52,18 +52,18 @@ Note that the `template_variables:` section only needs to be used if you do want Due to Flixpatrol data limitations, Apple TV only works with the `world` location. If you set a country-specific location, Apple TV will fall-back to using the `world` location. - | Variable | Description & Values | - |:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Any Number 1-10 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Any Number 1-10 | - | `in_the_last` | **Description:** Changes How many days of daily Top 10 Lists to look at.
**Default:** `1`
**Values:** Any Number 1-30 | - | `in_the_last_<>`1 | **Description:** Changes How many days of daily Top 10 Lists to look at.
**Default:** `in_the_last`
**Values:** Any Number 1-30 | - | `location` | **Description:** Changes the Builder Location for all collections in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../files/builders/flixpatrol.md#top-platform-attributes) | - | `location_<>`1 | **Description:** Changes the Builder Location of the specified key's collection.
**Default:** `location`
**Values:** [`location` Attribute Options](../../files/builders/flixpatrol.md#top-platform-attributes) | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | Variable | Description & Values | + |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Any Number 1-10 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Any Number 1-10 | + | `in_the_last` | **Description:** Changes How many days of daily Top 10 Lists to look at.
**Default:** `1`
**Values:** Any Number 1-30 | + | `in_the_last_<>`1 | **Description:** Changes How many days of daily Top 10 Lists to look at.
**Default:** `in_the_last`
**Values:** Any Number 1-30 | + | `location` | **Description:** Changes the Builder Location for all collections in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../files/builders/flixpatrol.md#top-platform-attributes) | + | `location_<>`1 | **Description:** Changes the Builder Location of the specified key's collection.
**Default:** `location`
**Values:** [`location` Attribute Options](../../files/builders/flixpatrol.md#top-platform-attributes) | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index 9296f371..05a84b63 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -46,12 +46,12 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | 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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | 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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index 88c3ed60..766db7a2 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -32,53 +32,66 @@ libraries: - pmm: myanimelist ``` -## Template Variable Default Values +## Template Variables Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy. -| Variable | Description & Values | -|:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number greater than 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number greater than 0 | -| `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
| -| `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| -| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +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. -1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. +??? info "Click to expand" -{% - include-markdown "../collection_variables.md" -%} -### Example Template Variable Amendments + === "File-Specific Template Variables" -The below is an example config.yml extract with some Template Variables added in to change how the file works. + The below template variables are available specifically for this PMM Defaults file. -???+ tip + Be sure to also check out the "Shared Template Variables" tab for additional variables. - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + | Variable | Description & Values | + |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number greater than 0 | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -```yaml -libraries: - Movies: - collection_files: - - pmm: myanimelist - template_variables: - use_season: false #(1)! - order_popular: 01 #(2)! - limit_popular: 20 #(3)! - visible_library_popular: true #(4)! - visible_home_popular: true #(5)! - visible_shared_popular: true #(6)! -``` + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. + + === "Shared Template Variables" + + {% + 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. + + ???+ tip + + Anywhere you see this icon: + + > :fontawesome-solid-circle-plus: + + That's a tooltip, you can press them to get more information. + + ```yaml + libraries: + Movies: + collection_files: + - pmm: myanimelist + template_variables: + use_season: false #(1)! + order_popular: 01 #(2)! + limit_popular: 20 #(3)! + visible_library_popular: true #(4)! + visible_home_popular: true #(5)! + visible_shared_popular: true #(6)! + ``` -1. Do not create the "MyAnimeList Season" collection -2. Change the order of "MyAnimeList Popular" to appear before all other collections created by this file -3. Limit the "MyAnimeList Popular" collection to 20 items. -4. Pin the "MyAnimeList Popular" collection to the Recommended tab of the library -5. Pin the "MyAnimeList Popular" collection to the home screen of the server owner -6. Pin the "MyAnimeList Popular" collection to the home screen of other users of the server \ No newline at end of file + 1. Do not create the "MyAnimeList Season" collection + 2. Change the order of "MyAnimeList Popular" to appear before all other collections created by this file + 3. Limit the "MyAnimeList Popular" collection to 20 items. + 4. Pin the "MyAnimeList Popular" collection to the Recommended tab of the library + 5. Pin the "MyAnimeList Popular" collection to the home screen of the server owner + 6. Pin the "MyAnimeList Popular" collection to the home screen of other users of the server \ No newline at end of file diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 63bad7f5..1c5ed397 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -47,13 +47,13 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | Variable | Description & Values | - |:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.
**Default:** `30`
**Values:** Number greater than 0 | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | Variable | Description & Values | + |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.
**Default:** `30`
**Values:** Number greater than 0 | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 5557eb7d..80ec604c 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -45,16 +45,16 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | 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 | - | `list_days_<>`1 | **Description:** Changes the `list_days` attribute of the builder of the specified key's collection.
**Values:** Number greater than 0 | - | `list_size` | **Description:** Changes the `list_size` attribute of the builder for all collections in a Defaults file.
**Values:** Number greater than 0 | - | `list_size_<>`1 | **Description:** Changes the `list_size` attribute of the builder of the specified key's collection.
**Values:** Number greater than 0 | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | 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 | + | `list_days_<>`1 | **Description:** Changes the `list_days` attribute of the builder of the specified key's collection.
**Values:** Number greater than 0 | + | `list_size` | **Description:** Changes the `list_size` attribute of the builder for all collections in a Defaults file.
**Values:** Number greater than 0 | + | `list_size_<>`1 | **Description:** Changes the `list_size` attribute of the builder of the specified key's collection.
**Values:** Number greater than 0 | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index 1a82b35b..cdb312c9 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -48,14 +48,14 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | Variable | Description & Values | - |:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number greater than 0 | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | Variable | Description & Values | + |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number greater than 0 | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index 600c0ec2..73a1e764 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -49,14 +49,14 @@ Note that the `template_variables:` section only needs to be used if you do want Be sure to also check out the "Shared Template Variables" tab for additional variables. - | Variable | Description & Values | - |:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | Variable | Description & Values | + |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index 070d27cf..fc94a549 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -49,21 +49,21 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Content Ratings found in your library | + | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Content Ratings found in your library | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -104,92 +104,35 @@ Note that the `template_variables:` section only needs to be used if you do want 3. Defines a collection which will be called "R", this does not need to already exist in your library 4. Adds the "de/18" content rating to the "R" addon list, "de/18" must exist in your library if the "R" content rating does not -## Default values +## Default Values -???+ tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`**: +
```yaml - include: - - G - - PG - - PG-13 - - R - - NC-17 + include: {% + include-markdown "../../../defaults/movie/content_rating_us.yml" + comments=false + preserve-includer-indent=false + start="include:" + end="addons:" + %} ``` - **Default `addons`**: +??? example "Default `addons` (click to expand) " + +
```yaml - addons: - G: - - gb/U - - gb/0+ - - U - - TV-Y - - TV-G - - E - - gb/E - - 1 - - 2 - - 3 - - 4 - - 5 - - 6 - - "01" - - "02" - - "03" - - "04" - - "05" - - "06" - - G - All Ages - PG: - - gb/PG - - gb/9+ - - TV-PG - - TV-Y7 - - TV-Y7-FV - - 7 - - 8 - - 9 - - "07" - - "08" - - "09" - - "10" - - "11" - - PG - Children - PG-13: - - gb/12A - - gb/12 - - 12+ - - TV-13 - - gb/14+ - - gb/15 - - TV-14 - - 12 - - 13 - - 14 - - 15 - - 16 - - PG-13 - Teens 13 or older - R: - - 17 - - 18 - - gb/18 - - MA-17 - - TVMA - - TV-MA - - R - 17+ (violence & profanity) - - R+ - Mild Nudity - NC-17: - - gb/R18 - - gb/X - - R18 - - X - - Rx - Hentai + addons: {% + include-markdown "../../../defaults/movie/content_rating_us.yml" + comments=false + preserve-includer-indent=false + start="addons:" + %} ``` diff --git a/docs/defaults/movie/continent.md b/docs/defaults/movie/continent.md index 5075bd64..5d89f2a9 100644 --- a/docs/defaults/movie/continent.md +++ b/docs/defaults/movie/continent.md @@ -51,22 +51,23 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `style` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Countries found in your library | - | `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of Countries found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Countries found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Countries found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Countries found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Countries found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Countries found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `style` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** List of Countries found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Countries found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Countries found in your library | + | `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of Countries found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Countries found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Countries found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Countries found in your library | + | `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).
**Values:** Dictionary with `key: new_key_name` entries | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -107,381 +108,35 @@ Note that the `template_variables:` section only needs to be used if you do want 3. Set the [Color Style](#color-style) 4. Exclude "Europe" from the list of collections that are created -## Default values +## Default Values -???+ tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`**: +
```yaml - include: - - Africa - - Americas - - Antarctica - - Asia - - Europe - - Oceania + include: {% + include-markdown "../../../defaults/movie/continent.yml" + comments=false + preserve-includer-indent=false + start="include:" + end="addons:" + %} ``` - **Default `addons`**: +??? example "Default `addons` (click to expand) " + +
```yaml - addons: - Africa: - # Northern Africa: - - Algeria - - Egypt - - Libya - - Morocco - - Sudan - - Tunisia - - Western Sahara - # Eastern Africa: - - British Indian Ocean Territory - - Burundi - - Comoros - - Djibouti - - Eritrea - - Ethiopia - - French Southern Territories - - Kenya - - Madagascar - - Malawi - - Mauritius - - Mayotte - - Mozambique - - Réunion - - Rwanda - - Seychelles - - Somalia - - South Sudan - - Uganda - - Tanzania - - United Republic of Tanzania # Tanzania - - Zambia - - Zimbabwe - # Central Africa: - - Angola - - Cameroon - - Central African Republic - - Chad - - Republic of the Congo - - Congo # Republic of the Congo - - Democratic Republic of the Congo - - Zaire # Democratic Republic of the Congo - - Equatorial Guinea - - Gabon - - São Tomé and Príncipe - - Sao Tome and Principe # São Tomé and Príncipe - # Southern Africa: - - Botswana - - Eswatini - - Swaziland # Eswatini - - Lesotho - - Namibia - - South Africa - # Western Africa: - - Benin - - Burkina Faso - - Cape Verde - - Cabo Verde # Cape Verde - - Côte d'Ivoire - - Côte d’Ivoire # Côte d'Ivoire - - Ivory Coast # Côte d'Ivoire - - Gambia - - Ghana - - Guinea - - Guinea-Bissau - - Liberia - - Mali - - Mauritania - - Niger - - Nigeria - - Saint Helena, Ascension and Tristan da Cunha - - Saint Helena # Saint Helena, Ascension and Tristan da Cunha - - St. Helena # Saint Helena, Ascension and Tristan da Cunha - - Ascension # Saint Helena, Ascension and Tristan da Cunha - - Tristan da Cunha # Saint Helena, Ascension and Tristan da Cunha - - Senegal - - Sierra Leone - - Togo - Americas: - # Caribbean: - - Anguilla - - Antigua and Barbuda - - Antigua # Antigua and Barbuda - - Barbuda # Antigua and Barbuda - - Aruba - - Bahamas - - Barbados - - Bonaire, Sint Eustatius and Saba - - Bonaire # Bonaire, Sint Eustatius and Saba - - Sint Eustatius # Bonaire, Sint Eustatius and Saba - - Saba # Bonaire, Sint Eustatius and Saba - - Netherlands Antilles - - British Virgin Islands - - Cayman Islands - - Cuba - - Curaçao - - Dominica - - Dominican Republic - - Grenada - - Guadeloupe - - Haiti - - Jamaica - - Martinique - - Montserrat - - Puerto Rico - - Saint Barthélemy - - Saint Kitts and Nevis - - St. Kitts and Nevis # Saint Kitts and Nevis - - Saint Lucia - - St. Lucia # Saint Lucia - - Saint Martin - - Saint Vincent and the Grenadines - - Saint Vincent and Grenadines # Saint Vincent and the Grenadines - - St. Vincent and the Grenadines # Saint Vincent and the Grenadines - - St. Vincent and Grenadines # Saint Vincent and the Grenadines - - Sint Maarten - - Trinidad and Tobago - - Turks and Caicos Islands - - US Virgin Islands - - U.S. Virgin Islands # US Virgin Islands - - United States Virgin Islands # US Virgin Islands - # Central America: - - Belize - - Costa Rica - - El Salvador - - Guatemala - - Honduras - - Mexico - - Nicaragua - - Panama - # South America: - - Argentina - - Bolivia - - Plurinational State of Bolivia # Bolivia - - Bouvet Island - - Brazil - - Chile - - Colombia - - Ecuador - - Falkland Islands - - Malvinas # Falkland Islands - - French Guiana - - Guyana - - Paraguay - - Peru - - South Georgia and the South Sandwich Islands - - South Georgia and South Sandwich Islands # South Georgia and the South Sandwich Islands - - South Georgia # South Georgia and the South Sandwich Islands - - South Sandwich Islands # South Georgia and the South Sandwich Islands - - Suriname - - Uruguay - - Venezuela - - Bolivarian Republic of Venezuela # Venezuela - # North America: - - Bermuda - - Canada - - Greenland - - Saint Pierre and Miquelon - - St. Pierre and Miquelon # Saint Pierre and Miquelon - - United States - - United States of America # United States - Antarctica: - - Antarctica - Asia: - # Central Asia: - - Kazakhstan - - Kyrgyzstan - - Tajikistan - - Turkmenistan - - Uzbekistan - # Eastern Asia: - - China - - Hong Kong - - Hong Kong SAR China # Hong Kong - - Macao - - Macau # Macao - - Macau SAR China # Macao - - North Korea - - Democratic People's Republic of Korea # North Korea - - Japan - - Mongolia - - South Korea - - Republic of Korea # South Korea - - Korea # South Korea - - Taiwan - - Taiwan, Province of China # Taiwan - # South-Eastern Asia: - - Brunei - - Brunei Darussalam # Brunei - - Cambodia - - Indonesia - - Laos - - Lao People's Democratic Republic # Laos - - Lao # Laos - - Malaysia - - Myanmar - - Burma # Myanmar - - Philippines - - Singapore - - Thailand - - East Timor - - Timor-Leste # East Timor - - Vietnam - - Viet Nam # Vietnam - # Southern Asia: - - Afghanistan - - Bangladesh - - Bhutan - - India - - Iran - - Islamic Republic of Iran # Iran - - Maldives - - Nepal - - Pakistan - - Sri Lanka - # Western Asia: - - Armenia - - Azerbaijan - - Bahrain - - Cyprus - - Georgia - - Iraq - - Israel - - Jordan - - Kuwait - - Lebanon - - Oman - - Qatar - - Saudi Arabia - - Palestine - - State of Palestine # Palestine - - Syria - - Syrian Arab Republic # Syria - - Turkey - - Türkiye # Turkey - - United Arab Emirates - - Yemen - Europe: - # Eastern Europe: - - Belarus - - Bulgaria - - Czech Republic - - Czechia # Czech Republic - - Czechoslovakia # Czech Republic - - Hungary - - Poland - - Moldova - - Republic of Moldova # Moldova - - Romania - - Russia - - Russian Federation # Russia - - Soviet Union - - Slovakia - - Ukraine - # Northern Europe: - - Åland Islands - - Guernsey - - Jersey - - Sark - - Denmark - - Estonia - - Faroe Islands - - Finland - - Iceland - - Ireland - - Northern Ireland - - Isle of Man - - Latvia - - Lithuania - - Norway - - Svalbard and Jan Mayen Islands - - Svalbard and Jan Mayen # Svalbard and Jan Mayen Islands - - Sweden - - United Kingdom - # Southern Europe: - - Albania - - Andorra - - Bosnia and Herzegovina - - Croatia - - Gibraltar - - Greece - - Kosovo - - Vatican City - - Holy See # Vatican City - - Italy - - Malta - - Montenegro - - North Macedonia - - Macedonia # North Macedonia - - Republic of North Macedonia # North Macedonia - - Portugal - - San Marino - - Serbia - - Serbia and Montenegro - - Slovenia - - Spain - - Yugoslavia - # Western Europe: - - Austria - - Belgium - - France - - French Republic # France - - Germany - - East Germany - - Liechtenstein - - Luxembourg - - Monaco - - Netherlands - - Switzerland - Oceania: - # Australia and New Zealand: - - Australia - - Christmas Island - - Cocos (Keeling) Islands - - Heard Island and McDonald Islands - - Heard and McDonald Islands # Heard Island and McDonald Islands - - New Zealand - - Norfolk Island - # Melanesia: - - Fiji - - New Caledonia - - Papua New Guinea - - New Guinea # Papua New Guinea - - Solomon Islands - - Vanuatu - # Micronesia: - - Guam - - Kiribati - - Marshall Islands - - Micronesia - - Federated States of Micronesia # Micronesia - - Nauru - - Northern Mariana Islands - - Palau - - US Minor Outlying Islands - - United States Minor Outlying Islands # US Minor Outlying Islands - - United States Outlying Islands # US Minor Outlying Islands - - U.S. Minor Outlying Islands # US Minor Outlying Islands - - U.S. Outlying Islands # US Minor Outlying Islands - - US Outlying Islands # US Minor Outlying Islands - # Polynesia: - - American Samoa - - Cook Islands - - French Polynesia - - Niue - - Pitcairn - - Pitcairn Islands # Pitcairn - - Samoa - - Tokelau - - Tonga - - Tuvalu - - Wallis and Futuna Islands - - Wallis and Futuna # Wallis and Futuna Islands + addons: {% + include-markdown "../../../defaults/movie/continent.yml" + comments=false + preserve-includer-indent=false + start="addons:" + %} ``` diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index 16eaf5ad..09a580f8 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -51,22 +51,23 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `style` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Countries found in your library | - | `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of Countries found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Countries found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Countries found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Countries found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Countries found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Countries found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `style` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** List of Countries found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Countries found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Countries found in your library | + | `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of Countries found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Countries found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Countries found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Countries found in your library | + | `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).
**Values:** Dictionary with `key: new_key_name` entries | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -107,418 +108,35 @@ Note that the `template_variables:` section only needs to be used if you do want 3. Set the [Color Style](#color-style) 4. Exclude "France" from the list of collections that are created -## Default values +## Default Values -???+ tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `include` (click to expand) " - **Default `include`**: +
```yaml - include: - # Northern Africa: - - Algeria - - Egypt - - Libya - - Morocco - - Sudan - - Tunisia - - Western Sahara - # Eastern Africa: - - British Indian Ocean Territory - - Burundi - - Comoros - - Djibouti - - Eritrea - - Ethiopia - - French Southern Territories - - Kenya - - Madagascar - - Malawi - - Mauritius - - Mayotte - - Mozambique - - Réunion - - Rwanda - - Seychelles - - Somalia - - South Sudan - - Uganda - - Tanzania - - Zambia - - Zimbabwe - # Central Africa: - - Angola - - Cameroon - - Central African Republic - - Chad - - Republic of the Congo - - Democratic Republic of the Congo - - Equatorial Guinea - - Gabon - - São Tomé and Príncipe - # Southern Africa: - - Botswana - - Eswatini - - Lesotho - - Namibia - - South Africa - # Western Africa: - - Benin - - Burkina Faso - - Cape Verde - - Côte d'Ivoire - - Gambia - - Ghana - - Guinea - - Guinea-Bissau - - Liberia - - Mali - - Mauritania - - Niger - - Nigeria - - Saint Helena, Ascension and Tristan da Cunha - - Senegal - - Sierra Leone - - Togo - # Caribbean: - - Anguilla - - Antigua and Barbuda - - Aruba - - Bahamas - - Barbados - - Bonaire, Sint Eustatius and Saba - - Netherlands Antilles - - British Virgin Islands - - Cayman Islands - - Cuba - - Curaçao - - Dominica - - Dominican Republic - - Grenada - - Guadeloupe - - Haiti - - Jamaica - - Martinique - - Montserrat - - Puerto Rico - - Saint Barthélemy - - Saint Kitts and Nevis - - Saint Lucia - - Saint Martin - - Saint Vincent and the Grenadines - - Sint Maarten - - Trinidad and Tobago - - Turks and Caicos Islands - - US Virgin Islands - # Central America: - - Belize - - Costa Rica - - El Salvador - - Guatemala - - Honduras - - Mexico - - Nicaragua - - Panama - # South America: - - Argentina - - Bolivia - - Bouvet Island - - Brazil - - Chile - - Colombia - - Ecuador - - Falkland Islands - - French Guiana - - Guyana - - Paraguay - - Peru - - South Georgia and the South Sandwich Islands - - Suriname - - Uruguay - - Venezuela - # North America: - - Bermuda - - Canada - - Greenland - - Saint Pierre and Miquelon - - United States - # Antarctica: - - Antarctica - # Central Asia: - - Kazakhstan - - Kyrgyzstan - - Tajikistan - - Turkmenistan - - Uzbekistan - # Eastern Asia: - - China - - Hong Kong - - Macao - - North Korea - - Japan - - Mongolia - - South Korea - - Taiwan - # South-Eastern Asia: - - Brunei - - Cambodia - - Indonesia - - Laos - - Malaysia - - Myanmar - - Philippines - - Singapore - - Thailand - - East Timor - - Vietnam - # Southern Asia: - - Afghanistan - - Bangladesh - - Bhutan - - India - - Iran - - Maldives - - Nepal - - Pakistan - - Sri Lanka - # Western Asia: - - Armenia - - Azerbaijan - - Bahrain - - Cyprus - - Georgia - - Iraq - - Israel - - Jordan - - Kuwait - - Lebanon - - Oman - - Qatar - - Saudi Arabia - - Palestine - - Syria - - Turkey - - United Arab Emirates - - Yemen - # Eastern Europe: - - Belarus - - Bulgaria - - Czech Republic - - Hungary - - Poland - - Moldova - - Romania - - Russia - - Slovakia - - Ukraine - # Northern Europe: - - Åland Islands - - Guernsey - - Jersey - - Sark - - Denmark - - Estonia - - Faroe Islands - - Finland - - Iceland - - Ireland - - Northern Ireland - - Isle of Man - - Latvia - - Lithuania - - Norway - - Svalbard and Jan Mayen Islands - - Sweden - - United Kingdom - # Southern Europe: - - Albania - - Andorra - - Bosnia and Herzegovina - - Croatia - - Gibraltar - - Greece - - Kosovo - - Vatican City - - Italy - - Malta - - Montenegro - - North Macedonia - - Portugal - - San Marino - - Serbia - - Serbia and Montenegro - - Slovenia - - Spain - - Yugoslavia - # Western Europe: - - Austria - - Belgium - - France - - Germany - - Liechtenstein - - Luxembourg - - Monaco - - Netherlands - - Switzerland - #Australia and New Zealand: - - Australia - - Christmas Island - - Cocos (Keeling) Islands - - Heard Island and McDonald Islands - - New Zealand - - Norfolk Island - # Melanesia: - - Fiji - - New Caledonia - - Papua New Guinea - - Solomon Islands - - Vanuatu - # Micronesia: - - Guam - - Kiribati - - Marshall Islands - - Micronesia - - Nauru - - Northern Mariana Islands - - Palau - - US Minor Outlying Islands - # Polynesia: - - American Samoa - - Cook Islands - - French Polynesia - - Niue - - Pitcairn Islands - - Samoa - - Tokelau - - Tonga - - Tuvalu - - Wallis and Futuna Islands + include: {% + include-markdown "../../../defaults/movie/country.yml" + comments=false + preserve-includer-indent=false + start="include:" + end="addons:" + %} ``` - **Default `addons`**: +??? example "Default `addons` (click to expand) " + +
```yaml - addons: - Tanzania: - - United Republic of Tanzania - Republic of the Congo: - - Congo - Democratic Republic of the Congo: - - Zaire - São Tomé and Príncipe: - - Sao Tome and Principe - Eswatini: - - Swaziland - Cape Verde: - - Cabo Verde - Côte d'Ivoire: - - Côte d’Ivoire - - Ivory Coast - Saint Helena, Ascension and Tristan da Cunha: - - Saint Helena - - St. Helena - - Ascension - - Tristan da Cunha - Antigua and Barbuda: - - Antigua - - Barbuda - Bonaire, Sint Eustatius and Saba: - - Bonaire - - Sint Eustatius - - Saba - Saint Kitts and Nevis: - - St. Kitts and Nevis - Saint Lucia: - - St. Lucia - Saint Vincent and the Grenadines: - - Saint Vincent and Grenadines - - St. Vincent and the Grenadines - - St. Vincent and Grenadines - US Virgin Islands: - - U.S. Virgin Islands - - United States Virgin Islands - Bolivia: - - Plurinational State of Bolivia - Falkland Islands: - - Malvinas - South Georgia and the South Sandwich Islands: - - South Georgia and South Sandwich Islands - - South Georgia - - South Sandwich Islands - Venezuela: - - Bolivarian Republic of Venezuela - Saint Pierre and Miquelon: - - St. Pierre and Miquelon - United States: - - United States of America - Hong Kong: - - Hong Kong SAR China - Macao: - - Macau - - Macau SAR China - North Korea: - - Democratic People's Republic of Korea - South Korea: - - Republic of Korea - - Korea - Taiwan: - - Taiwan, Province of China - Brunei: - - Brunei Darussalam - Laos: - - Lao People's Democratic Republic - - Lao - Myanmar: - - Burma - East Timor: - - Timor-Leste - Vietnam: - - Viet Nam - Iran: - - Islamic Republic of Iran - Palestine: - - State of Palestine - Syria: - - Syrian Arab Republic - Turkey: - - Türkiye - Czech Republic: - - Czechia - - Czechoslovakia - Moldova: - - Republic of Moldova - Russia: - - Russian Federation - - Soviet Union - Svalbard and Jan Mayen Islands: - - Svalbard and Jan Mayen - Vatican City: - - Holy See - North Macedonia: - - Macedonia - - Republic of North Macedonia - France: - - French Republic - Germany: - - East Germany - Heard Island and McDonald Islands: - - Heard and McDonald Islands - Papua New Guinea: - - New Guinea - Micronesia: - - Federated States of Micronesia - US Minor Outlying Islands: - - United States Minor Outlying Islands - - United States Outlying Islands - - U.S. Minor Outlying Islands - - U.S. Outlying Islands - - US Outlying Islands - Pitcairn Islands: - - Pitcairn - Wallis and Futuna Islands: - - Wallis and Futuna + addons: {% + include-markdown "../../../defaults/movie/country.yml" + comments=false + preserve-includer-indent=false + start="addons:" + %} ``` diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index 4f9c6fc3..7996034e 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -44,15 +44,15 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Top <> <>s of the <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Top <> <>s of the <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index 00afc339..869058d8 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -49,8 +49,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `style` | **Description:** Controls the visual theme of the collections created.
**Default:** `bw`
**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Default: 5
Values: Number greater than 0
limitControls the maximum number of collections to create
Default: 25
Values: Number greater than 0
| | `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.
**Values:** List of Actor Names | | `exclude` | **Description:** Exclude these Directors from creating a Dynamic Collection.
**Values:** List of Director Names | diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index c776a0cc..4eeef497 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -43,35 +43,35 @@ Note that the `template_variables:` section only needs to be used if you do want **[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.** - | Variable | Description & Values | - |:-----------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `summary_<>`1 | **Description:** Changes the summary of the specified key's collection.
**Values:** New Collection Summary | - | `collection_section` | **Description:** Adds a sort title with this collection sections.
**Values:** Any number | - | `order_<>`1 | **Description:** Controls the sort order of the collections in their collection section.
**Values:** Any number | - | `collection_mode` | **Description:** Controls the collection mode of all collections in this file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| - | `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | - | `movie_<>`1 | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#default-movie) for that collection if used.
**Values:** List of TMDb Movie IDs | - | `name_mapping_<>`1 | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#default-name_mapping) for that collection if used.
**Values:** Any String | - | `sort_title` | **Description:** Sets the sort title for all collections. Use `<>` to use the collection name. **Example:** `"!02_<>"`
**Values:** Any String with `<>` | - | `sort_title_<>`1 | **Description:** Sets the sort title of the specified key's collection.
**Default:** `sort_title`
**Values:** Any String | - | `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.
**Values:** `false` to not build the collection | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `title_override` | **Description:** Overrides the [default title_override dictionary](#default-title_override).
**Values:** Dictionary with `key: new_title` entries | - | `exclude` | **Description:** Exclude these TMDb Collections from creating a Dynamic Collection.
**Values:** List of TMDb Collection IDs | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of TMDb Collection IDs | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of TMDb Collection IDs | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of TMDb Collection IDs | - | `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | - | `radarr_add_missing_<>`1 | **Description:** Override Radarr `add_missing` attribute of the specified key's collection.
**Default:** `radarr_add_missing`
**Values:** `true` or `false` | - | `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.
**Values:** Folder Path | - | `radarr_folder_<>`1 | **Description:** Override Radarr `root_folder_path` attribute of the specified key's collection.
**Default:** `radarr_folder`
**Values:** Folder Path | - | `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | - | `radarr_tag_<>`1 | **Description:** Override Radarr `tag` attribute of the specified key's collection.
**Default:** `radarr_tag`
**Values:** List or comma-separated string of tags | - | `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | - | `item_radarr_tag_<>`1 | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.
**Default:** `item_radarr_tag`
**Values:** List or comma-separated string of tags | + | Variable | Description & Values | + |:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `summary_<>`1 | **Description:** Changes the summary of the specified key's collection.
**Values:** New Collection Summary | + | `collection_section` | **Description:** Adds a sort title with this collection sections.
**Values:** Any number | + | `order_<>`1 | **Description:** Controls the sort order of the collections in their collection section.
**Values:** Any number | + | `collection_mode` | **Description:** Controls the collection mode of all collections in this file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| + | `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | + | `movie_<>`1 | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#movie) for that collection if used.
**Values:** List of TMDb Movie IDs | + | `name_mapping_<>`1 | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#name_mapping) for that collection if used.
**Values:** Any String | + | `sort_title` | **Description:** Sets the sort title for all collections. Use `<>` to use the collection name. **Example:** `"!02_<>"`
**Values:** Any String with `<>` | + | `sort_title_<>`1 | **Description:** Sets the sort title of the specified key's collection.
**Default:** `sort_title`
**Values:** Any String | + | `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.
**Values:** `false` to not build the collection | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `title_override` | **Description:** Overrides the [default title_override dictionary](#title_override).
**Values:** Dictionary with `key: new_title` entries | + | `exclude` | **Description:** Exclude these TMDb Collections from creating a Dynamic Collection.
**Values:** List of TMDb Collection IDs | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of TMDb Collection IDs | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of TMDb Collection IDs | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of TMDb Collection IDs | + | `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | + | `radarr_add_missing_<>`1 | **Description:** Override Radarr `add_missing` attribute of the specified key's collection.
**Default:** `radarr_add_missing`
**Values:** `true` or `false` | + | `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.
**Values:** Folder Path | + | `radarr_folder_<>`1 | **Description:** Override Radarr `root_folder_path` attribute of the specified key's collection.
**Default:** `radarr_folder`
**Values:** Folder Path | + | `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | + | `radarr_tag_<>`1 | **Description:** Override Radarr `tag` attribute of the specified key's collection.
**Default:** `radarr_tag`
**Values:** List or comma-separated string of tags | + | `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | + | `item_radarr_tag_<>`1 | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.
**Default:** `item_radarr_tag`
**Values:** List or comma-separated string of tags | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -103,15 +103,15 @@ Note that the `template_variables:` section only needs to be used if you do want 2. Add [TMDb Movie 336560](https://www.themoviedb.org/movie/336560-lake-placid-vs-anaconda) to [TMDb Collection 105995](https://www.themoviedb.org/collection/105995-anaconda-collection) 3. Add items missing from your library in Plex to Radarr. When used in this particular file, hundreds if not thousands of items may be sent to Radarr - proceed with caution! -## Default values +## Default Values -???+ tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `addons` (click to expand) " - **Default `addons`**: +
```yaml addons: {% @@ -123,6 +123,10 @@ Note that the `template_variables:` section only needs to be used if you do want %} ``` +??? example "Default `title_override` (click to expand) " + +
+ **Default `title_override`**: ```yaml @@ -135,18 +139,36 @@ Note that the `template_variables:` section only needs to be used if you do want %} ``` - **Default Template Variables `movie` & `name_mapping`**: +??? example "Default Template Variable `movie` (click to expand) " + +
???+ tip - Pass `movie_<>` and `name_mapping_<>` to the file as template variables and you can change these - values. + Pass `movie_<>` to the file as template variables to change this value per collection. ```yaml - movie: {% + movie: {% + include-markdown "../../../defaults/movie/franchise.yml" + comments=false + start="# check1" + end="name_mapping:" + %} + ``` + +??? example "Default Template Variable `name_mapping` (click to expand) " + +
+ + ???+ tip + + Pass `name_mapping_<>` to the file as template variables to change this value per collection. + + ```yaml + name_mapping: {% include-markdown "../../../defaults/movie/franchise.yml" comments=false preserve-includer-indent=false - start="template_variables:" + start="# check2" %} ``` diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index add932fc..aafaf4c0 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -49,8 +49,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `style` | **Description:** Controls the visual theme of the collections created.
**Default:** `bw`
**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Default: 5
Values: Number greater than 0
limitControls the maximum number of collections to create
Default: 25
Values: Number greater than 0
| | `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.
**Values:** List of Actor Names | | `exclude` | **Description:** Exclude these Producers from creating a Dynamic Collection.
**Values:** List of Producer Names | diff --git a/docs/defaults/movie/region.md b/docs/defaults/movie/region.md index 26924d3f..7e603758 100644 --- a/docs/defaults/movie/region.md +++ b/docs/defaults/movie/region.md @@ -51,22 +51,23 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `style` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| - | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Countries found in your library | - | `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of Countries found in your library | - | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Countries found in your library | - | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Countries found in your library | - | `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Countries found in your library | - | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Countries found in your library | - | `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Countries found in your library | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in <>.`
**Values:** Any string. | + | Variable | Description & Values | + |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `style` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| + | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `include` | **Description:** Overrides the [default include list](#include).
**Values:** List of Countries found in your library | + | `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of Countries found in your library | + | `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Countries found in your library | + | `append_include` | **Description:** Appends to the [default include list](#include).
**Values:** List of Countries found in your library | + | `remove_include` | **Description:** Removes from the [default include list](#include).
**Values:** List of Countries found in your library | + | `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).
**Values:** Dictionary List of Countries found in your library | + | `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).
**Values:** Dictionary List of Countries found in your library | + | `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).
**Values:** Dictionary with `key: new_key_name` entries | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in <>.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -107,392 +108,35 @@ Note that the `template_variables:` section only needs to be used if you do want 3. Set the [Color Style](#color-style) 4. Exclude "French" from the list of collections that are created -## Default values +## Default Values -???+ tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. - **Default `include`**: +??? example "Default `include` (click to expand) " + +
```yaml - include: - - Northern Africa - - Eastern Africa - - Central Africa - - Southern Africa - - Western Africa - - Caribbean - - Central America - - South America - - North America - - Antarctica - - Central Asia - - Eastern Asia - - South-Eastern Asia - - Southern Asia - - Western Asia - - Eastern Europe - - Northern Europe - - Southern Europe - - Western Europe - - Australia and New Zealand - - Melanesia - - Micronesia - - Polynesia + include: {% + include-markdown "../../../defaults/movie/region.yml" + comments=false + preserve-includer-indent=false + start="include:" + end="addons:" + %} ``` - **Default `addons`**: +??? example "Default `addons` (click to expand) " + +
```yaml - addons: - Northern Africa: - - Algeria - - Egypt - - Libya - - Morocco - - Sudan - - Tunisia - - Western Sahara - Eastern Africa: - - British Indian Ocean Territory - - Burundi - - Comoros - - Djibouti - - Eritrea - - Ethiopia - - French Southern Territories - - Kenya - - Madagascar - - Malawi - - Mauritius - - Mayotte - - Mozambique - - Réunion - - Rwanda - - Seychelles - - Somalia - - South Sudan - - Uganda - - Tanzania - - United Republic of Tanzania # Tanzania - - Zambia - - Zimbabwe - Central Africa: - - Angola - - Cameroon - - Central African Republic - - Chad - - Republic of the Congo - - Congo # Republic of the Congo - - Democratic Republic of the Congo - - Zaire # Democratic Republic of the Congo - - Equatorial Guinea - - Gabon - - São Tomé and Príncipe - - Sao Tome and Principe # São Tomé and Príncipe - Southern Africa: - - Botswana - - Eswatini - - Swaziland # Eswatini - - Lesotho - - Namibia - - South Africa - Western Africa: - - Benin - - Burkina Faso - - Cape Verde - - Cabo Verde # Cape Verde - - Côte d'Ivoire - - Côte d’Ivoire # Côte d'Ivoire - - Ivory Coast # Côte d'Ivoire - - Gambia - - Ghana - - Guinea - - Guinea-Bissau - - Liberia - - Mali - - Mauritania - - Niger - - Nigeria - - Saint Helena, Ascension and Tristan da Cunha - - Saint Helena # Saint Helena, Ascension and Tristan da Cunha - - St. Helena # Saint Helena, Ascension and Tristan da Cunha - - Ascension # Saint Helena, Ascension and Tristan da Cunha - - Tristan da Cunha # Saint Helena, Ascension and Tristan da Cunha - - Senegal - - Sierra Leone - - Togo - Caribbean: - - Anguilla - - Antigua and Barbuda - - Antigua # Antigua and Barbuda - - Barbuda # Antigua and Barbuda - - Aruba - - Bahamas - - Barbados - - Bonaire, Sint Eustatius and Saba - - Bonaire # Bonaire, Sint Eustatius and Saba - - Sint Eustatius # Bonaire, Sint Eustatius and Saba - - Saba # Bonaire, Sint Eustatius and Saba - - Netherlands Antilles - - British Virgin Islands - - Cayman Islands - - Cuba - - Curaçao - - Dominica - - Dominican Republic - - Grenada - - Guadeloupe - - Haiti - - Jamaica - - Martinique - - Montserrat - - Puerto Rico - - Saint Barthélemy - - Saint Kitts and Nevis - - St. Kitts and Nevis # Saint Kitts and Nevis - - Saint Lucia - - St. Lucia # Saint Lucia - - Saint Martin - - Saint Vincent and the Grenadines - - Saint Vincent and Grenadines # Saint Vincent and the Grenadines - - St. Vincent and the Grenadines # Saint Vincent and the Grenadines - - St. Vincent and Grenadines # Saint Vincent and the Grenadines - - Sint Maarten - - Trinidad and Tobago - - Turks and Caicos Islands - - US Virgin Islands - - U.S. Virgin Islands # US Virgin Islands - - United States Virgin Islands # US Virgin Islands - Central America: - - Belize - - Costa Rica - - El Salvador - - Guatemala - - Honduras - - Mexico - - Nicaragua - - Panama - South America: - - Argentina - - Bolivia - - Plurinational State of Bolivia # Bolivia - - Bouvet Island - - Brazil - - Chile - - Colombia - - Ecuador - - Falkland Islands - - Malvinas # Falkland Islands - - French Guiana - - Guyana - - Paraguay - - Peru - - South Georgia and the South Sandwich Islands - - South Georgia and South Sandwich Islands # South Georgia and the South Sandwich Islands - - South Georgia # South Georgia and the South Sandwich Islands - - South Sandwich Islands # South Georgia and the South Sandwich Islands - - Suriname - - Uruguay - - Venezuela - - Bolivarian Republic of Venezuela # Venezuela - North America: - - Bermuda - - Canada - - Greenland - - Saint Pierre and Miquelon - - St. Pierre and Miquelon # Saint Pierre and Miquelon - - United States - - United States of America # United States - Antarctica: - - Antarctica - Central Asia: - - Kazakhstan - - Kyrgyzstan - - Tajikistan - - Turkmenistan - - Uzbekistan - Eastern Asia: - - China - - Hong Kong - - Hong Kong SAR China # Hong Kong - - Macao - - Macau # Macao - - Macau SAR China # Macao - - North Korea - - Democratic People's Republic of Korea # North Korea - - Japan - - Mongolia - - South Korea - - Republic of Korea # South Korea - - Korea # South Korea - - Taiwan - - Taiwan, Province of China # Taiwan - South-Eastern Asia: - - Brunei - - Brunei Darussalam # Brunei - - Cambodia - - Indonesia - - Laos - - Lao People's Democratic Republic # Laos - - Lao # Laos - - Malaysia - - Myanmar - - Burma # Myanmar - - Philippines - - Singapore - - Thailand - - East Timor - - Timor-Leste # East Timor - - Vietnam - - Viet Nam # Vietnam - Southern Asia: - - Afghanistan - - Bangladesh - - Bhutan - - India - - Iran - - Islamic Republic of Iran # Iran - - Maldives - - Nepal - - Pakistan - - Sri Lanka - Western Asia: - - Armenia - - Azerbaijan - - Bahrain - - Cyprus - - Georgia - - Iraq - - Israel - - Jordan - - Kuwait - - Lebanon - - Oman - - Qatar - - Saudi Arabia - - Palestine - - State of Palestine # Palestine - - Syria - - Syrian Arab Republic # Syria - - Turkey - - Türkiye # Turkey - - United Arab Emirates - - Yemen - Eastern Europe: - - Belarus - - Bulgaria - - Czech Republic - - Czechia # Czech Republic - - Czechoslovakia # Czech Republic - - Hungary - - Poland - - Moldova - - Republic of Moldova # Moldova - - Romania - - Russia - - Russian Federation # Russia - - Soviet Union # Russia - - Slovakia - - Ukraine - Northern Europe: - - Åland Islands - - Guernsey - - Jersey - - Sark - - Denmark - - Estonia - - Faroe Islands - - Finland - - Iceland - - Ireland - - Northern Ireland - - Isle of Man - - Latvia - - Lithuania - - Norway - - Svalbard and Jan Mayen Islands - - Svalbard and Jan Mayen # Svalbard and Jan Mayen Islands - - Sweden - - United Kingdom - Southern Europe: - - Albania - - Andorra - - Bosnia and Herzegovina - - Croatia - - Gibraltar - - Greece - - Kosovo - - Vatican City - - Holy See # Vatican City - - Italy - - Malta - - Montenegro - - North Macedonia - - Macedonia # North Macedonia - - Republic of North Macedonia # North Macedonia - - Portugal - - San Marino - - Serbia - - Serbia and Montenegro - - Slovenia - - Spain - - Yugoslavia - Western Europe: - - Austria - - Belgium - - France - - French Republic # France - - Germany - - East Germany - - Liechtenstein - - Luxembourg - - Monaco - - Netherlands - - Switzerland - Australia and New Zealand: - - Australia - - Christmas Island - - Cocos (Keeling) Islands - - Heard Island and McDonald Islands - - Heard and McDonald Islands # Heard Island and McDonald Islands - - New Zealand - - Norfolk Island - Melanesia: - - Fiji - - New Caledonia - - Papua New Guinea - - New Guinea # Papua New Guinea - - Solomon Islands - - Vanuatu - Micronesia: - - Guam - - Kiribati - - Marshall Islands - - Micronesia - - Federated States of Micronesia # Micronesia - - Nauru - - Northern Mariana Islands - - Palau - - US Minor Outlying Islands - - United States Minor Outlying Islands # US Minor Outlying Islands - - United States Outlying Islands # US Minor Outlying Islands - - U.S. Minor Outlying Islands # US Minor Outlying Islands - - U.S. Outlying Islands # US Minor Outlying Islands - - US Outlying Islands # US Minor Outlying Islands - Polynesia: - - American Samoa - - Cook Islands - - French Polynesia - - Niue - - Pitcairn - - Pitcairn Islands # Pitcairn - - Samoa - - Tokelau - - Tonga - - Tuvalu - - Wallis and Futuna Islands - - Wallis and Futuna # Wallis and Futuna Islands + addons: {% + include-markdown "../../../defaults/movie/region.yml" + comments=false + preserve-includer-indent=false + start="addons:" + %} ``` diff --git a/docs/defaults/movie/seasonal.md b/docs/defaults/movie/seasonal.md index c10c44fe..df8d0674 100644 --- a/docs/defaults/movie/seasonal.md +++ b/docs/defaults/movie/seasonal.md @@ -60,28 +60,30 @@ Note that the `template_variables:` section only needs to be used if you do want This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. - | Variable | Description & Values | - |:--------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `tmdb_collection_<>`1 | **Description:** Adds the TMDb Collection IDs given to the specified key's collection. Overrides the [default tmdb_collection](#default-tmdb_collection) for that collection if used.
**Values:** List of TMDb Collection IDs | - | `tmdb_movie_<>`1 | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default tmdb_movie](#default-tmdb_movie) for that collection if used.
**Values:** List of TMDb Movie IDs | | - | `imdb_list_<>`1 | **Description:** Adds the Movies in the IMDb List to the specified key's collection. Overrides the [default imdb_list](#default-imdb_list) for that collection if used.
**Values:** List of IMDb List URLs | | | - | `trakt_list_<>`1 | **Description:** Adds the Movies in the Trakt List to the specified key's collection.
**Values:** List of Trakt List URLs | | | | - | `mdblist_list_<>`1 | **Description:** Adds the Movies in the MDb List to the specified key's collection.
**Values:** List of MDbList URLs | | | | - | `emoji` | **Description:** Controls the Emoji Prefix for all Collections. Set to `""` to remove all emojis.
**Values:** Any String | - | `emoji_<>`1 | **Description:** Controls the Emoji Prefix for the specified key's collection.
**Values:** Any String | - | `limit` | **Description:** Changes the Builder Limit for all collections in this file.
**Values:** Number Greater than 0 | - | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `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
| - | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in this file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `schedule` | **Description:** Changes the Schedule for all collections in this file. Use `daily` to have all collections show.
**Values:** [Any Schedule Option](../../config/schedule.md) | - | `schedule_<>`1 | **Description:** Changes the Schedule of the specified key's collection. Overrides the [default schedule](#default-schedule) for that collection if used.
**Values:** [Any Schedule Option](../../config/schedule.md) | - | `data` | **Description:** Overrides the [default data dictionary](#default-data). Defines the data that the custom dynamic collection processes.
**Values:** Dictionary List of keys/names | - | `append_data` | **Description:** Appends to the [default data dictionary](#default-data).
**Values:** Dictionary List of keys/names | - | `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.
**Values:** List of Seasons Keys | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `A collection of <> <>s that may relate to the season.`
**Values:** Any string. | + | Variable | Description & Values | + |:--------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `tmdb_collection_<>`1 | **Description:** Adds the TMDb Collection IDs given to the specified key's collection. Overrides the [default tmdb_collection](#tmdb-collection) for that collection if used.
**Values:** List of TMDb Collection IDs | + | `tmdb_movie_<>`1 | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default tmdb_movie](#tmdb-movie) for that collection if used.
**Values:** List of TMDb Movie IDs | | + | `imdb_list_<>`1 | **Description:** Adds the Movies in the IMDb List to the specified key's collection. Overrides the [default imdb_list](#imdb-list) for that collection if used.
**Values:** List of IMDb List URLs | | | + | `imdb_search_<>`1 | **Description:** Adds the Movies in the IMDb Search to the specified key's collection. Overrides the [default imdb_search](#imdb-search) for that collection if used.
**Values:** List of IMDb List URLs | | | + | `trakt_list_<>`1 | **Description:** Adds the Movies in the Trakt List to the specified key's collection. Overrides the [default trakt_list](#trakt-list) for that collection if used.
**Values:** List of Trakt List URLs | | | | + | `mdblist_list_<>`1 | **Description:** Adds the Movies in the MDb List to the specified key's collection. Overrides the [default mdblist_list](#mdblist-list) for that collection if used.
**Values:** List of MDbList URLs | | | | + | `emoji` | **Description:** Controls the Emoji Prefix for all Collections. Set to `""` to remove all emojis.
**Values:** Any String | + | `emoji_<>`1 | **Description:** Controls the Emoji Prefix for the specified key's collection. Overrides the [default emoji](#emoji) for that collection if used.
**Values:** Any String | + | `limit` | **Description:** Changes the Builder Limit for all collections in this file.
**Values:** Number Greater than 0 | + | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | + | `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
| + | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in this file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `schedule` | **Description:** Changes the Schedule for all collections in this file. Use `daily` to have all collections show.
**Values:** [Any Schedule Option](../../config/schedule.md) | + | `schedule_<>`1 | **Description:** Changes the Schedule of the specified key's collection. Overrides the [default schedule](#schedule) for that collection if used.
**Values:** [Any Schedule Option](../../config/schedule.md) | + | `data` | **Description:** Overrides the [default data dictionary](#data). Defines the data that the custom dynamic collection processes.
**Values:** Dictionary List of keys/names | + | `append_data` | **Description:** Appends to the [default data dictionary](#data).
**Values:** Dictionary List of keys/names | + | `remove_data` | **Description:** Removes from the [default data dictionary](#data).
**Values:** List of keys to remove | + | `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.
**Values:** List of Seasons Keys | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `A collection of <> <>s that may relate to the season.`
**Values:** Any string. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. @@ -127,146 +129,166 @@ Note that the `template_variables:` section only needs to be used if you do want 6. Add an IMDb List to be used for the "Planet of the Apes Day" collection 7. Add the 🐵 emoji to the "Planet of the Apes Day" collection so that the title in Plex is "🐵 Planet of the Apes Day Movies" -## Default values +## Default Values -??? tip +These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** - These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** +If you want to customize these values, use the methods described above. - If you want to customize these values, use the methods described above. +??? example "Default `data` (click to expand) " - **Default `data`**: +
```yaml - data: - years: New Year's Day - valentine: Valentine's Day - patrick: St. Patrick's Day - easter: Easter - mother: Mother's Day - memorial: Memorial Day - father: Father's Day - independence: Independence Day - labor: Labor Day - halloween: Halloween - veteran: Veteran's Day - thanksgiving: Thanksgiving - christmas: Christmas - aapi: Asian American & Pacific Islander Heritage Month - disabilities: Day of Persons with Disabilities - black_history: Black History Month - lgbtq: LGBTQ+ Pride Month - latinx: Latinx Heritage Month - women: Women's History Month + data: {% + include-markdown "../../../defaults/movie/seasonal.yml" + comments=false + preserve-includer-indent=false + start="data:" + end="title_format:" + %} ``` - **Default `tmdb_collection`**: +??? example "Default Template Variable `emoji` (click to expand) " + +
+ + ???+ tip + + Pass `emoji_<>` to the file as template variables to change this value per collection. + + ```yaml + emoji: {% + include-markdown "../../../defaults/movie/seasonal.yml" + comments=false + preserve-includer-indent=false + start="# check1" + end="schedule:" + %} + ``` + +??? example "Default Template Variable `schedule` (click to expand) " + +
+ + ???+ tip + + Pass `schedule_<>` to the file as template variables to change this value per collection. ```yaml - tmdb_collection: - halloween: - - 185103 # Hotel Transylvania - - 11716 # Addams Family - - 750822 # Addams Family Animated - - 313086 # Conjuring - - 91361 # Halloween Collection - - 8581 # A Nightmare on Elm Street Collection - - 1733 # The Mummy Collection - - 8091 # Alien Collection - - 2980 # Ghostbusters - - 751156 # Hocus Pocus + schedule: {% + include-markdown "../../../defaults/movie/seasonal.yml" + comments=false + preserve-includer-indent=false + start="# check2" + end="imdb_list:" + %} ``` - **Default `tmdb_movie`**: +??? example "Default Template Variable `imdb_list` (click to expand) " + +
+ + ???+ tip + + Pass `imdb_list_<>` to the file as template variables to change this value per collection. ```yaml - tmdb_movie: - halloween: - - 23437 # A Nightmare on Elm Street (2010) + imdb_list: {% + include-markdown "../../../defaults/movie/seasonal.yml" + comments=false + preserve-includer-indent=false + start="# check3" + end="imdb_search:" + %} ``` - **Default `imdb_list`**: +??? example "Default Template Variable `imdb_search` (click to expand) " + +