diff --git a/VERSION b/VERSION index c5c4351a..4ba5beb0 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.19.1-develop83 +1.19.1-develop84 diff --git a/defaults/award/berlinale.yml b/defaults/award/berlinale.yml new file mode 100644 index 00000000..0b3d8ce1 --- /dev/null +++ b/defaults/award/berlinale.yml @@ -0,0 +1,58 @@ +############################################################################## +# Berlinale Awards Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/award/berlinale # +############################################################################## + +external_templates: + pmm: templates + template_variables: + collection_section: 130 + +collections: + Berlinale Golden Bears: + variables: + key: golden + template: + - name: shared + sort: Berlinale ! + allowed_libraries: movie + image: award/berlinale/winner + translation_key: berlinale_best + - name: arr + - name: custom + imdb_award: + event_id: ev0000091 + event_year: all + award_filter: golden berlin bear + winning: true + +dynamic_collections: + Berlinale Awards: + type: imdb_awards + sync: true + data: + event_id: ev0000091 + starting: latest-5 + ending: latest + title_format: Berlinale <> + template: + - use_year_collections + - imdb_award + - shared + - arr + - custom + template_variables: + winning: + default: true + collection_order: + default: release + allowed_libraries: + default: movie + image: + default: award/berlinale/<> + translation_key: + default: berlinale_year + dynamic: + default: true diff --git a/defaults/award/cesar.yml b/defaults/award/cesar.yml new file mode 100644 index 00000000..ecdc8454 --- /dev/null +++ b/defaults/award/cesar.yml @@ -0,0 +1,59 @@ +############################################################################## +# Cesar Awards Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/award/cesar # +############################################################################## + +external_templates: + pmm: templates + template_variables: + collection_section: 130 + +collections: + César Best Film Winners: + variables: + key: best + template: + - name: shared + sort: Cesar ! + allowed_libraries: movie + image: award/cesar/winner + translation_key: cesar_best + - name: arr + - name: custom + imdb_award: + event_id: ev0000157 + event_year: all + award_filter: César + category_filter: best film (meilleur film) + winning: true + +dynamic_collections: + Cesar Awards: + type: imdb_awards + sync: true + data: + event_id: ev0000157 + starting: latest-5 + ending: latest + title_format: Cesar <> + template: + - use_year_collections + - imdb_award + - shared + - arr + - custom + template_variables: + winning: + default: true + collection_order: + default: release + allowed_libraries: + default: movie + image: + default: award/cesar/<> + translation_key: + default: cesar_year + dynamic: + default: true diff --git a/defaults/award/emmy.yml b/defaults/award/emmy.yml index ebf1fcc0..75af1c36 100644 --- a/defaults/award/emmy.yml +++ b/defaults/award/emmy.yml @@ -10,6 +10,48 @@ external_templates: template_variables: collection_section: 130 +collections: + Emmys Best in Category Winners: + variables: + key: best + template: + - name: shared + sort: Emmys ! + allowed_libraries: show + image: award/emmys/winner + translation_key: emmy_best + - name: arr + - name: custom + imdb_award: + event_id: ev0000223 + event_year: all + category_filter: + - best comedy series + - best comedy show + - best dramatic anthology series + - best dramatic program + - best dramatic series + - best dramatic series - less than one hour + - best dramatic series - one hour or longer + - best series - half hour or less + - best series - one hour or more + - outstanding animated program + - outstanding animated program (for programming less than one hour) + - outstanding animated program (for programming more than one hour) + - outstanding animated program (for programming one hour or less) + - outstanding animated program (for programming one hour or more) + - outstanding animated programming + - outstanding comedy series + - outstanding drama series + - outstanding drama series - continuing + - outstanding drama/comedy - limited episodes + - outstanding dramatic program + - outstanding dramatic series + - outstanding miniseries + - outstanding series - comedy + - outstanding series - drama + winning: true + dynamic_collections: Emmy Awards: type: imdb_awards diff --git a/defaults/award/nfr.yml b/defaults/award/nfr.yml new file mode 100644 index 00000000..74d23dc6 --- /dev/null +++ b/defaults/award/nfr.yml @@ -0,0 +1,57 @@ +############################################################################## +# National Film Registry Awards Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/award/nfr # +############################################################################## + +external_templates: + pmm: templates + template_variables: + collection_section: 130 + +collections: + National Film Registry All Time: + variables: + key: all_time + template: + - name: shared + sort: National Film Registry ! + allowed_libraries: movie + image: award/nfr/all_time + translation_key: nfr_best + - name: arr + - name: custom + imdb_award: + event_id: ev0000468 + event_year: all + winning: true + +dynamic_collections: + National Film Registry Awards: + type: imdb_awards + sync: true + data: + event_id: ev0000468 + starting: latest-5 + ending: latest + title_format: National Film Registry <> + template: + - use_year_collections + - imdb_award + - shared + - arr + - custom + template_variables: + winning: + default: true + collection_order: + default: release + allowed_libraries: + default: movie + image: + default: award/nfr/<> + translation_key: + default: nfr_year + dynamic: + default: true diff --git a/defaults/award/other_award.yml b/defaults/award/other_award.yml deleted file mode 100644 index 09adbae4..00000000 --- a/defaults/award/other_award.yml +++ /dev/null @@ -1,76 +0,0 @@ -############################################################################## -# 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 # -############################################################################## - -external_templates: - pmm: templates - template_variables: - collection_section: 130 - -collections: - Berlinale Golden Bears: - variables: - key: berlinale - template: - - name: shared - allowed_libraries: movie - image: award/berlinale/winner - translation_key: berlinale_best - - name: arr - - name: custom - imdb_award: - event_id: ev0000091 - event_year: all - category_filter: best film - winning: true - - César Best Film Winners: - variables: - key: cesar - template: - - name: shared - allowed_libraries: movie - image: award/cesar/winner - translation_key: cesar_best - - name: arr - - name: custom - imdb_award: - event_id: ev0000157 - event_year: all - category_filter: best film (meilleur film) - winning: true - - Razzies Golden Raspberry Winners: - variables: - key: razzie - template: - - name: shared - allowed_libraries: movie - image: award/razzie/winner - translation_key: razzie_worst - - name: arr - - name: custom - imdb_award: - event_id: ev0000558 - event_year: all - category_filter: worst picture - winning: true - - Venice Golden Lions: - variables: - key: venice - template: - - name: shared - allowed_libraries: movie - image: award/venice/winner - translation_key: venice_best - - name: arr - - name: custom - imdb_award: - event_id: ev0000681 - event_year: all - award_filter: golden lion - winning: true diff --git a/defaults/award/pca.yml b/defaults/award/pca.yml new file mode 100644 index 00000000..9ec488b7 --- /dev/null +++ b/defaults/award/pca.yml @@ -0,0 +1,64 @@ +############################################################################## +# People's 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/pca # +############################################################################## + +external_templates: + pmm: templates + template_variables: + collection_section: 130 + +collections: + Peoples Choice Award Winners: + variables: + key: best + template: + - name: shared + sort: People's Choice Awards ! + image: award/pca/winner + translation_key: pca_best + - name: arr + - name: custom + imdb_award: + event_id: ev0000530 + event_year: all + category_filter: + - all-time favorite tv program + - favorite all-time motion picture + - favorite motion picture + - favorite movie + - favorite non-musical motion picture + - favorite overall motion picture + - favorite tv show + - the movie of 2022 + - the show of 2021 + winning: true + +dynamic_collections: + Peoples Choice Awards: + type: imdb_awards + sync: true + data: + event_id: ev0000530 + starting: latest-5 + ending: latest + title_format: People's Choice Awards <> + template: + - use_year_collections + - imdb_award + - shared + - arr + - custom + template_variables: + winning: + default: true + collection_order: + default: release + image: + default: award/pca/<> + translation_key: + default: pca_year + dynamic: + default: true diff --git a/defaults/award/razzie.yml b/defaults/award/razzie.yml new file mode 100644 index 00000000..3657f130 --- /dev/null +++ b/defaults/award/razzie.yml @@ -0,0 +1,58 @@ +############################################################################## +# Razzie Awards Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/award/razzie # +############################################################################## + +external_templates: + pmm: templates + template_variables: + collection_section: 130 + +collections: + Razzies Golden Raspberry Winners: + variables: + key: golden + template: + - name: shared + sort: Razzie ! + allowed_libraries: movie + image: award/razzie/winner + translation_key: razzie_worst + - name: arr + - name: custom + imdb_award: + event_id: ev0000558 + event_year: all + category_filter: worst picture + winning: true + +dynamic_collections: + Razzie Awards: + type: imdb_awards + sync: true + data: + event_id: ev0000558 + starting: latest-5 + ending: latest + title_format: Razzie <> + template: + - use_year_collections + - imdb_award + - shared + - arr + - custom + template_variables: + winning: + default: true + collection_order: + default: release + allowed_libraries: + default: movie + image: + default: award/razzie/<> + translation_key: + default: razzie_year + dynamic: + default: true diff --git a/defaults/award/sag.yml b/defaults/award/sag.yml new file mode 100644 index 00000000..1041a99c --- /dev/null +++ b/defaults/award/sag.yml @@ -0,0 +1,61 @@ +############################################################################## +# Screen Actors Guild Awards Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/award/sag # +############################################################################## + +external_templates: + pmm: templates + template_variables: + collection_section: 130 + +collections: + Screen Actors Guild Award Winners: + variables: + key: best + template: + - name: shared + sort: Screen Actors Guild ! + image: award/sag/winner + translation_key: sag_best + - name: arr + - name: custom + imdb_award: + event_id: ev0000598 + event_year: all + category_filter: + - outstanding performance by a cast + - outstanding performance by a cast in a motion picture + - outstanding performance by a cast in a theatrical motion picture + - outstanding performance by an ensemble in a comedy series + - outstanding performance by an ensemble in a drama series + - outstanding performance by the cast of a theatrical motion picture + winning: true + +dynamic_collections: + Screen Actors Guild Awards: + type: imdb_awards + sync: true + data: + event_id: ev0000598 + starting: latest-5 + ending: latest + title_format: Screen Actors Guild <> + template: + - use_year_collections + - imdb_award + - shared + - arr + - custom + template_variables: + winning: + default: true + collection_order: + default: release + image: + default: award/sag/<> + translation_key: + default: sag_year + dynamic: + default: true diff --git a/defaults/award/tiff.yml b/defaults/award/tiff.yml new file mode 100644 index 00000000..ef2c7289 --- /dev/null +++ b/defaults/award/tiff.yml @@ -0,0 +1,65 @@ +############################################################################## +# Toronto International Film Festival Awards Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/award/tiff # +############################################################################## + +external_templates: + pmm: templates + template_variables: + collection_section: 130 + +collections: + Toronto People's Choice Award Winners: + variables: + key: best + template: + - name: shared + sort: Toronto International Film Festival ! + allowed_libraries: movie + image: award/tiff/winner + translation_key: tiff_best + - name: arr + - name: custom + imdb_award: + event_id: ev0000659 + event_year: all + award_filter: + - people's choice award + - grolsch people's choice award + category_filter: + - best film + - people's choice award + - grolsch people's choice award + - gala or special presentations + winning: true + +dynamic_collections: + Toronto International Film Festival Awards: + type: imdb_awards + sync: true + data: + event_id: ev0000659 + starting: latest-5 + ending: latest + title_format: Toronto International Film Festival <> + template: + - use_year_collections + - imdb_award + - shared + - arr + - custom + template_variables: + winning: + default: true + collection_order: + default: release + allowed_libraries: + default: movie + image: + default: award/tiff/<> + translation_key: + default: tiff_year + dynamic: + default: true diff --git a/defaults/award/venice.yml b/defaults/award/venice.yml new file mode 100644 index 00000000..4d0ddb20 --- /dev/null +++ b/defaults/award/venice.yml @@ -0,0 +1,66 @@ +############################################################################## +# Venice Awards Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/award/venice # +############################################################################## + +external_templates: + pmm: templates + template_variables: + collection_section: 130 + +collections: + Venice Golden Lions: + variables: + key: golden + template: + - name: shared + sort: Venice ! + allowed_libraries: movie + image: award/venice/winner + translation_key: venice_best + - name: arr + - name: custom + imdb_award: + event_id: ev0000681 + event_year: all + award_filter: + - golden lion + - international critics award + - grand international award + category_filter: + - golden lion + - best feature film + - best film + - grand international award + winning: true + +dynamic_collections: + Venice Awards: + type: imdb_awards + sync: true + data: + event_id: ev0000681 + starting: latest-5 + ending: latest + title_format: Venice <> + template: + - use_year_collections + - imdb_award + - shared + - arr + - custom + template_variables: + winning: + default: true + collection_order: + default: release + allowed_libraries: + default: movie + image: + default: award/venice/<> + translation_key: + default: venice_year + dynamic: + default: true diff --git a/defaults/both/collectionless.yml b/defaults/both/collectionless.yml index ed6a112c..316737d3 100644 --- a/defaults/both/collectionless.yml +++ b/defaults/both/collectionless.yml @@ -8,9 +8,11 @@ templates: collectionless: default: + # check1 exclude_prefix: - "!" - "~" + # check2 sort_title: ~_Collectionless collection_order: alpha url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/collectionless.jpg diff --git a/defaults/both/universe.yml b/defaults/both/universe.yml index fa9a8bec..9b5d9825 100644 --- a/defaults/both/universe.yml +++ b/defaults/both/universe.yml @@ -81,13 +81,13 @@ dynamic_collections: fast: movie rocky: movie mummy: movie - trakt_url: # check1 + trakt_url: 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 + mdblist_url: avp: https://mdblist.com/lists/plexmetamanager/external/16872 arrow: https://mdblist.com/lists/plexmetamanager/external/15113 dca: https://mdblist.com/lists/plexmetamanager/external/15405 @@ -100,5 +100,6 @@ dynamic_collections: askew: https://mdblist.com/lists/plexmetamanager/external/15362 wizard: https://mdblist.com/lists/plexmetamanager/external/23683 xmen: https://mdblist.com/lists/plexmetamanager/external/9244 + # check3 image: default: universe/<> diff --git a/defaults/chart/anilist.yml b/defaults/chart/anilist.yml index e6e5c4cb..5ad14b6d 100644 --- a/defaults/chart/anilist.yml +++ b/defaults/chart/anilist.yml @@ -22,12 +22,12 @@ templates: season: default: limit: 100 - limit_trending: <> + limit_season: <> anilist_search: season: current year: sort_by: popular - limit: <> + limit: <> collections: AniList Popular: diff --git a/defaults/movie/franchise.yml b/defaults/movie/franchise.yml index cd499710..20362529 100644 --- a/defaults/movie/franchise.yml +++ b/defaults/movie/franchise.yml @@ -97,8 +97,8 @@ dynamic_collections: 535313: Godzilla (MonsterVerse) 535790: Godzilla (Anime) template_variables: + # check1 movie: - # check1 105995: 336560 # Anaconda: Lake Placid vs. Anaconda 176097: 14177 # Barbershop: Beauty Shop 448150: 567604 # Deadpool: Once Upon a Deadpool @@ -125,8 +125,8 @@ dynamic_collections: 10194: 130925 # Toy Story: Partysaurus Rex 63043: 73362 # TRON: TRON: The Next Day 748: 567604 # X-Men: Once Upon a Deadpool + # check2 name_mapping: - # check2 1565: 28 Days-Weeks Later 508334: Angels in the 115838: Escape From diff --git a/defaults/movie/seasonal.yml b/defaults/movie/seasonal.yml index 75ad93f7..db5162e7 100644 --- a/defaults/movie/seasonal.yml +++ b/defaults/movie/seasonal.yml @@ -101,8 +101,8 @@ dynamic_collections: - shared - arr template_variables: + # check1 emoji: - # check1 years: "🎊 " valentine: "💘 " patrick: "☘ " @@ -122,8 +122,8 @@ dynamic_collections: latinx: "🪅 " women: "🚺 " black_history: "✊ 🏿 " + # check2 schedule: - # check2 years: range(12/26-01/04) valentine: range(02/01-02/29) patrick: range(03/01-03/18) @@ -143,8 +143,8 @@ dynamic_collections: lgbtq: range(05/31-06/30) latinx: range(09/15-10/15) women: range(02/28-03/31) + # check3 imdb_list: - # check3 years: https://www.imdb.com/list/ls066838460/ valentine: - https://www.imdb.com/list/ls000094398/ @@ -170,14 +170,14 @@ dynamic_collections: - https://www.imdb.com/list/ls000835734/ - https://www.imdb.com/list/ls091597850/ christmas: https://www.imdb.com/list/ls000096828/ + # check4 imdb_search: - # check4 women: keyword.any: women in film, womens rights, womens suffrage sort_by: rating.desc limit: 500 + # check5 tmdb_collection: - # check5 halloween: - 185103 # Hotel Transylvania - 11716 # Addams Family @@ -189,12 +189,12 @@ dynamic_collections: - 8091 # Alien Collection - 2980 # Ghostbusters - 751156 # Hocus Pocus + # check6 tmdb_movie: - # check6 halloween: - 23437 # A Nightmare on Elm Street (2010) + # check7 mdblist_list: - # check7 aapi: - https://mdblist.com/lists/plexmetamanager/asian-american-pacific-islander-heritage-month disabilities: @@ -203,11 +203,12 @@ dynamic_collections: - https://mdblist.com/lists/plexmetamanager/lgbtq-pride-month latinx: - https://mdblist.com/lists/plexmetamanager/latinx-heritage-month + # check8 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 + # check9 visible_home: default: true visible_shared: diff --git a/defaults/overlays/ribbon.yml b/defaults/overlays/ribbon.yml index 6899b5da..c59410a8 100644 --- a/defaults/overlays/ribbon.yml +++ b/defaults/overlays/ribbon.yml @@ -152,9 +152,35 @@ overlays: Emmys Winner: variables: {key: emmys, weight: 90} template: [name: standard, name: ribbon] - imdb_search: - event.winning: emmy - limit: 1000 + imdb_award: + event_id: ev0000223 + event_year: all + category_filter: + - best comedy series + - best comedy show + - best dramatic anthology series + - best dramatic program + - best dramatic series + - best dramatic series - less than one hour + - best dramatic series - one hour or longer + - best series - half hour or less + - best series - one hour or more + - outstanding animated program + - outstanding animated program (for programming less than one hour) + - outstanding animated program (for programming more than one hour) + - outstanding animated program (for programming one hour or less) + - outstanding animated program (for programming one hour or more) + - outstanding animated programming + - outstanding comedy series + - outstanding drama series + - outstanding drama series - continuing + - outstanding drama/comedy - limited episodes + - outstanding dramatic program + - outstanding dramatic series + - outstanding miniseries + - outstanding series - comedy + - outstanding series - drama + winning: true Critics Choice Winners: variables: {key: choice, weight: 80} diff --git a/defaults/templates.yml b/defaults/templates.yml index 9d21ad78..2e765085 100644 --- a/defaults/templates.yml +++ b/defaults/templates.yml @@ -71,8 +71,9 @@ templates: order: "" order_<>: <> schedule_<>: <> + sort: <> sort_prefix: "!" - sort_title: <<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>> + sort_title: <<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<sort>> item_radarr_tag_<<key>>: <<item_radarr_tag>> item_sonarr_tag_<<key>>: <<item_sonarr_tag>> url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/<<image>>.jpg diff --git a/docs/config/operations.md b/docs/config/operations.md index 75be16bc..1b684617 100644 --- a/docs/config/operations.md +++ b/docs/config/operations.md @@ -147,8 +147,8 @@ You can create individual blocks of operations by using a list under `operations <table class="clearTable"> <tr><td>`mdb`</td><td>Use MdbList for Content Ratings</td></tr> - <tr><td>`mdb_commonsense`</td><td>Use Commonsense Rating through MDbList for Content Ratings</td></tr> - <tr><td>`mdb_commonsense0`</td><td>Use Commonsense Rating with Zero Padding through MDbList for Content Ratings</td></tr> + <tr><td>`mdb_commonsense`</td><td>Use Common Sense Rating through MDbList for Content Ratings</td></tr> + <tr><td>`mdb_commonsense0`</td><td>Use Common Sense Rating with Zero Padding through MDbList for Content Ratings</td></tr> <tr><td>`omdb`</td><td>Use IMDb through OMDb for Content Ratings</td></tr> <tr><td>`mal`</td><td>Use MyAnimeList for Content Ratings</td></tr> <tr><td>`lock`</td><td>Lock Content Rating Field</td></tr> diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 2d4b00ee..e57477af 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -9,8 +9,6 @@ Arts Awards. Supported Library Types: Movie -Requirements: [Trakt Authentication](../../config/trakt.md) - ## Collections Section 130 | Collection | Key | Description | @@ -37,26 +35,26 @@ make your own local copy. Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" - | Variable | Description & Values | - |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | - | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | - | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `BAFTA <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> BAFTA Awards.`<br>**Values:** Any string with `<<key_name>>` in it. | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `BAFTA <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> BAFTA Awards.`<br>**Values:** Any string with `<<key_name>>` in it. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. @@ -67,30 +65,29 @@ work. Any value not specified will use its default value if it has one if not it include-markdown "../collection_variables.md" %} - ???+ example "Example Template Variable Amendments" - - The below is an example config.yml extract with some Template Variables added in to change how the file works. - - Click the :fontawesome-solid-circle-plus: icon to learn more - - ```yaml - libraries: - Movies: - collection_files: - - pmm: bafta - template_variables: - collection_mode: show_items #(1)! - collection_order: alpha #(2)! - radarr_add_missing: true #(3)! - name_format: BAFTA <<key_name>> Winners #(4)! - data: - starting: latest-10 #(5)! - ending: latest #(6)! - ``` - - 1. Shows the collection and all of its items within the Library tab in Plex - 2. Sorts the collection items alphabetically - 3. Adds items from the source list which are not in Plex to Radarr - 4. Change the name of the collections to "BAFTA yearhere Winners" - 5. If today is 2024, then create collections for BAFTA 2014 onwards - 6. If today is 2024, then the final collection is BAFTA 2024 \ No newline at end of file +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: bafta + template_variables: + collection_mode: show_items #(1)! + collection_order: alpha #(2)! + radarr_add_missing: true #(3)! + name_format: BAFTA <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest + ``` + + 1. Shows the collection and all of its items within the Library tab in Plex + 2. Sorts the collection items alphabetically + 3. Adds items from the source list which are not in Plex to Radarr + 4. Change the name of the collections to "BAFTA yearhere Winners" + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/berlinale.md b/docs/defaults/award/berlinale.md new file mode 100644 index 00000000..cf097d30 --- /dev/null +++ b/docs/defaults/award/berlinale.md @@ -0,0 +1,92 @@ +# Berlin International Film Festival Awards Collections + +The `berlinale` Default Collection File is used to create collections based on the Berlin International Film Festival Awards. + +![](../images/berlinale.png) + +## Requirements & Recommendations + +Supported Library Types: Movie + +## Collections Section 130 + +| Collection | Key | Description | +|:------------------------------------------------------|:----------------------------------|:-----------------------------------------------------------------------------------| +| `Berlinale Golden Bears` | `golden` | Collection of Berlin International Film Festival Golden Bear Award Winners. | +| `Berlinale <<year>>`<br>**Example:** `Berlinale 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Berlin International Film Festival Award Winners for the given year. | + +## Config + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + collection_files: + - pmm: berlinale +``` + +## Template Variables + +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `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. + +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Shared Template Variables** are additional variables shared across the PMM Defaults. + + === "File-Specific Template Variables" + + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Berlinale <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Berlinale Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + === "Shared Template Variables" + + {% + include-markdown "../collection_variables.md" + %} + +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: berlinale + template_variables: + collection_mode: show_items #(1)! + collection_order: alpha #(2)! + radarr_add_missing: true #(3)! + name_format: Berlinale <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest + ``` + + 1. Shows the collection and all of its items within the Library tab in Plex + 2. Sorts the collection items alphabetically + 3. Adds items from the source list which are not in Plex to Radarr + 4. Change the name of the collections to "Berlinale yearhere Winners" + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index a321ae77..840ad361 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -8,8 +8,6 @@ The `cannes` Default Collection File is used to create collections based on the Supported Library Types: Movie -Requirements: [Trakt Authentication](../../config/trakt.md) - ## Collections Section 130 | Collection | Key | Description | @@ -30,32 +28,35 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" - | Variable | Description & Values | - |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | - | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | - | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Cannes <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Cannes Awards.`<br>**Values:** Any string with `<<key_name>>` in it. | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Cannes <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Cannes Awards.`<br>**Values:** Any string with `<<key_name>>` in it. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -63,17 +64,11 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments +???+ example "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. + Click the :fontawesome-solid-circle-plus: icon to learn more ```yaml libraries: @@ -85,14 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want collection_order: alpha #(2)! radarr_add_missing: true #(3)! name_format: Cannes <<key_name>> Winners #(4)! - data: - starting: latest-10 #(5)! - ending: latest #(6)! + data: #(5)! + starting: latest-10 + ending: latest ``` 1. Shows the collection and all of its items within the Library tab in Plex 2. Sorts the collection items alphabetically 3. Adds items from the source list which are not in Plex to Radarr 4. Change the name of the collections to "Cannes yearhere Winners" - 5. If today is 2024, then create collections for Cannes 2014 onwards - 6. If today is 2024, then the final collection is Cannes 2024 \ No newline at end of file + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/cesar.md b/docs/defaults/award/cesar.md new file mode 100644 index 00000000..51c31330 --- /dev/null +++ b/docs/defaults/award/cesar.md @@ -0,0 +1,92 @@ +# César Awards Collections + +The `cesar` Default Collection File is used to create collections based on the César Awards. + +![](../images/cesar.png) + +## Requirements & Recommendations + +Supported Library Types: Movie + +## Collections Section 130 + +| Collection | Key | Description | +|:----------------------------------------------|:----------------------------------|:------------------------------------------------------| +| `César Best Film Winners` | `best` | Collection of César Award Winners. | +| `Cesar <<year>>`<br>**Example:** `Cesar 2022` | `<<year>>`<br>**Example:** `2022` | Collection of César Award Winners for the given year. | + +## Config + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + collection_files: + - pmm: cesar +``` + +## Template Variables + +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `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. + +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Shared Template Variables** are additional variables shared across the PMM Defaults. + + === "File-Specific Template Variables" + + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `César <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> César Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + === "Shared Template Variables" + + {% + include-markdown "../collection_variables.md" + %} + +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: cesar + template_variables: + collection_mode: show_items #(1)! + collection_order: alpha #(2)! + radarr_add_missing: true #(3)! + name_format: César <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest + ``` + + 1. Shows the collection and all of its items within the Library tab in Plex + 2. Sorts the collection items alphabetically + 3. Adds items from the source list which are not in Plex to Radarr + 4. Change the name of the collections to "César yearhere Winners" + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index 1d9fbb64..570dc05f 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -8,8 +8,6 @@ The `choice` Default Collection File is used to create collections based on the Supported Library Types: Movie, Show -Requirements: [Trakt Authentication](../../config/trakt.md) - ## Collections Section 130 | Collection | Key | Description | @@ -37,26 +35,26 @@ Template Variables can be used to manipulate the file in various ways to slightl 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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" - | Variable | Description & Values | - |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | - | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | - | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Critics Choice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Critics Choice Awards.`<br>**Values:** Any string with `<<key_name>>` in it. | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Critics Choice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Critics Choice Awards.`<br>**Values:** Any string with `<<key_name>>` in it. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. @@ -66,19 +64,12 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments +???+ example "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. - - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -89,15 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want collection_order: alpha #(2)! radarr_add_missing: true #(3)! name_format: Critics Choice Awards <<key_name>> Winners #(4)! - data: - starting: latest-10 #(5)! - ending: latest #(6)! + data: #(5)! + starting: latest-10 + ending: latest ``` 1. Shows the collection and all of its items within the Library tab in Plex 2. Sorts the collection items alphabetically 3. Adds items from the source list which are not in Plex to Radarr 4. Change the name of the collections to "Critics Choice Awards yearhere Winners" - 5. If today is 2024, then create collections for Critics Choice Awards 2014 onwards - 6. If today is 2024, then the final collection is Critics Choice Awards 2024 - + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index bb73c894..c27ee656 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -10,8 +10,9 @@ Supported Library Types: Movie, Show ## Collections Section 130 -| Collection | Key | Description | +| Collection | Key | | |:----------------------------------------------|:----------------------------------|:------------------------------------------------------| +| `Emmys Best in Category Winners` | `best` | Collection of Emmys Best in Category Award Winners. | | `Emmys <<year>>`<br>**Example:** `Emmys 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Emmys Award Winners for the given year. | ## Config @@ -34,26 +35,26 @@ Template Variables can be used to manipulate the file in various ways to slightl 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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" - | Variable | Description & Values | - |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | - | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | - | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Emmys <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Emmy Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Emmys <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Emmy Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. @@ -63,17 +64,11 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments +???+ example "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. + Click the :fontawesome-solid-circle-plus: icon to learn more ```yaml libraries: @@ -85,14 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want collection_order: alpha #(2)! radarr_add_missing: true #(3)! name_format: Emmys <<key_name>> Winners #(4)! - data: - starting: latest-10 #(5)! - ending: latest #(6)! + data: #(5)! + starting: latest-10 + ending: latest ``` 1. Shows the collection and all of its items within the Library tab in Plex 2. Sorts the collection items alphabetically 3. Adds items from the source list which are not in Plex to Radarr 4. Change the name of the collections to "Emmys yearhere Winners" - 5. If today is 2024, then create collections for Emmys 2014 onwards - 6. If today is 2024, then the final collection is Emmys 2024 \ No newline at end of file + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index 747843ac..f206b779 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -8,7 +8,8 @@ The `golden` Default Collection File is used to create collections based on the Supported Library Types: Movie, Show -Recommendations: The `Golden Globe Best Motion Pictures` Collection only works with Movie Libraries +Recommendations: The `Golden Globe Best Motion Pictures` and `Golden Globes Best Director Winners` Collections only work +with Movie Libraries. ## Collections Section 130 @@ -34,32 +35,35 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" - | Variable | Description & Values | - |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | - | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | - | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Golden Globe <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Golden Globe Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Golden Globe <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Golden Globe Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -67,17 +71,11 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments +???+ example "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. + Click the :fontawesome-solid-circle-plus: icon to learn more ```yaml libraries: @@ -89,14 +87,13 @@ Note that the `template_variables:` section only needs to be used if you do want collection_order: alpha #(2)! radarr_add_missing: true #(3)! name_format: Emmys <<key_name>> Winners #(4)! - data: - starting: latest-10 #(5)! - ending: latest #(6)! + data: #(5)! + starting: latest-10 + ending: latest ``` 1. Shows the collection and all of its items within the Library tab in Plex 2. Sorts the collection items alphabetically 3. Adds items from the source list which are not in Plex to Radarr 4. Change the name of the collections to "Golden Globes yearhere Winners" - 5. If today is 2024, then create collections for Golden Globes 2014 onwards - 6. If today is 2024, then the final collection is Golden Globes 2024 \ No newline at end of file + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/nfr.md b/docs/defaults/award/nfr.md new file mode 100644 index 00000000..3d84dbca --- /dev/null +++ b/docs/defaults/award/nfr.md @@ -0,0 +1,92 @@ +# National Film Registry Collections + +The `nfr` Default Collection File is used to create collections based on the National Film Registry. + +![](../images/nfr.png) + +## Requirements & Recommendations + +Supported Library Types: Movie + +## Collections Section 130 + +| Collection | Key | Description | +|:--------------------------------------------------------------------------------|:----------------------------------|:----------------------------------------------------------------------------| +| `National Film Registry All Time` | `all_time` | Collection of Films added to the National Film Registry. | +| `National Film Registry <<year>>`<br>**Example:** `National Film Registry 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Films added to the National Film Registry for the given year. | + +## Config + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + collection_files: + - pmm: nfr +``` + +## Template Variables + +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `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. + +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Shared Template Variables** are additional variables shared across the PMM Defaults. + + === "File-Specific Template Variables" + + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `National Film Registry <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> National Film Registry.`<br>**Values:** Any string with `<<key_name>>` in it. | + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + === "Shared Template Variables" + + {% + include-markdown "../collection_variables.md" + %} + +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: nfr + template_variables: + collection_mode: show_items #(1)! + collection_order: alpha #(2)! + radarr_add_missing: true #(3)! + name_format: National Film Registry <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest + ``` + + 1. Shows the collection and all of its items within the Library tab in Plex + 2. Sorts the collection items alphabetically + 3. Adds items from the source list which are not in Plex to Radarr + 4. Change the name of the collections to "National Film Registry yearhere Winners" + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index 71b3546b..e9c764ef 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -29,32 +29,35 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" - | Variable | Description & Values | - |:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | - | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | Variable | Description & Values | + |:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-6<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest-1<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | - | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Oscars Winners <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Academy Awards (Oscars) Winners for <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Oscars Winners <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Academy Awards (Oscars) Winners for <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -62,18 +65,11 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more ```yaml libraries: @@ -84,15 +80,14 @@ Note that the `template_variables:` section only needs to be used if you do want collection_mode: show_items #(1)! collection_order: alpha #(2)! radarr_add_missing: true #(3)! - name_format: Emmys <<key_name>> Winners #(4)! - data: - starting: latest-10 #(5)! - ending: latest #(6)! + name_format: Oscars <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest ``` 1. Shows the collection and all of its items within the Library tab in Plex 2. Sorts the collection items alphabetically 3. Adds items from the source list which are not in Plex to Radarr 4. Change the name of the collections to "Oscars YEAR_HERE Winners" - 5. If today is 2024, then create collections for Oscars 2014 onwards - 7. If today is 2024, then the final collection is Oscars 2024 + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md deleted file mode 100644 index 810babd7..00000000 --- a/docs/defaults/award/other.md +++ /dev/null @@ -1,89 +0,0 @@ -# Other Awards Collections - -The `other_award` Default Collection File is used to create collections based on numerous other awards. - -![](../images/awardother.png) - -## Requirements & Recommendations - -Supported Library Types: Movie, Show - -Requirements: [Trakt Authentication](../../config/trakt.md) - -## Collections Section 130 - -| Collection | Key | Description | -|:-----------------------------------|:------------|:--------------------------------------------------------------| -| `Berlinale Golden Bears` | `berlinale` | Collection of Berlinale Golden Bears Award Winners. | -| `César Best Film Winners` | `cesar` | Collection of César Best Film Winners Award Winners. | -| `Razzies Golden Raspberry Winners` | `razzie` | Collection of Razzies Golden Raspberry Winners Award Winners. | -| `Venice Golden Lions` | `venice` | Collection of Venice Golden Lions Award Winners. | - -## Config - -The below YAML in your config.yml will create the collections: - -```yaml -libraries: - Movies: - collection_files: - - pmm: other_award -``` - -## Template Variables - -Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy. - -Note that the `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. - -??? info "Click to expand" - - === "File-Specific Template Variables" - - The below template variables are available specifically for this PMM Defaults file. - - 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.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` 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: other_award - template_variables: - use_berlinale: false #(1)! - collection_order: alpha #(2)! - radarr_add_missing: true #(3)! - ``` - - 1. Do not create the "Berlinale Golden Bears" collection - 2. Sorts the collection items alphabetically - 3. Adds items from the source list which are not in Plex to Radarr \ No newline at end of file diff --git a/docs/defaults/award/pca.md b/docs/defaults/award/pca.md new file mode 100644 index 00000000..c23fa9ed --- /dev/null +++ b/docs/defaults/award/pca.md @@ -0,0 +1,92 @@ +# People's Choice Awards Collections + +The `pca` Default Collection File is used to create collections based on the People's Choice Awards. + +![](../images/pca.png) + +## Requirements & Recommendations + +Supported Library Types: Movie, Show + +## Collections Section 130 + +| Collection | Key | Description | +|:--------------------------------------------------------------------------------|:----------------------------------|:----------------------------------------------------------------| +| `People's Choice Award Winners` | `pca` | Collection of People's Choice Award Winners. | +| `People's Choice Awards <<year>>`<br>**Example:** `People's Choice Awards 2022` | `<<year>>`<br>**Example:** `2022` | Collection of People's Choice Award Winners for the given year. | + +## Config + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + collection_files: + - pmm: pca +``` + +## Template Variables + +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `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. + +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Shared Template Variables** are additional variables shared across the PMM Defaults. + + === "File-Specific Template Variables" + + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `People's Choice Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> People's Choice Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + === "Shared Template Variables" + + {% + include-markdown "../collection_variables.md" + %} + +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: pca + template_variables: + collection_mode: show_items #(1)! + collection_order: alpha #(2)! + radarr_add_missing: true #(3)! + name_format: People's Choice <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest + ``` + + 1. Shows the collection and all of its items within the Library tab in Plex + 2. Sorts the collection items alphabetically + 3. Adds items from the source list which are not in Plex to Radarr + 4. Change the name of the collections to "People's Choice yearhere Winners" + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/razzie.md b/docs/defaults/award/razzie.md new file mode 100644 index 00000000..17474533 --- /dev/null +++ b/docs/defaults/award/razzie.md @@ -0,0 +1,92 @@ +# Razzie Awards Collections + +The `razzie` Default Collection File is used to create collections based on the Razzie Awards. + +![](../images/razzie.png) + +## Requirements & Recommendations + +Supported Library Types: Movie + +## Collections Section 130 + +| Collection | Key | Description | +|:------------------------------------------------|:----------------------------------|:-------------------------------------------------------| +| `Razzies Golden Raspberry Winners` | `golden` | Collection of Razzie Golden Raspberry Award Winners. | +| `Razzie <<year>>`<br>**Example:** `Razzie 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Razzie Award Winners for the given year. | + +## Config + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + collection_files: + - pmm: razzie +``` + +## Template Variables + +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `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. + +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Shared Template Variables** are additional variables shared across the PMM Defaults. + + === "File-Specific Template Variables" + + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Razzie <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Razzie Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + === "Shared Template Variables" + + {% + include-markdown "../collection_variables.md" + %} + +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: razzie + template_variables: + collection_mode: show_items #(1)! + collection_order: alpha #(2)! + radarr_add_missing: true #(3)! + name_format: Razzie <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest + ``` + + 1. Shows the collection and all of its items within the Library tab in Plex + 2. Sorts the collection items alphabetically + 3. Adds items from the source list which are not in Plex to Radarr + 4. Change the name of the collections to "Razzie yearhere Winners" + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/sag.md b/docs/defaults/award/sag.md new file mode 100644 index 00000000..e1ada01e --- /dev/null +++ b/docs/defaults/award/sag.md @@ -0,0 +1,92 @@ +# Screen Actors Guild Awards Collections + +The `sag` Default Collection File is used to create collections based on the Screen Actors Guild Awards. + +![](../images/sag.png) + +## Requirements & Recommendations + +Supported Library Types: Movie + +## Collections Section 130 + +| Collection | Key | Description | +|:--------------------------------------------------------------------------|:----------------------------------|:--------------------------------------------------------------------| +| `Screen Actors Guild Award Winners` | `golden` | Collection of Screen Actors Guild Award Winners. | +| `Screen Actors Guild <<year>>`<br>**Example:** `Screen Actors Guild 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Screen Actors Guild Award Winners for the given year. | + +## Config + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + collection_files: + - pmm: sag +``` + +## Template Variables + +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `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. + +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Shared Template Variables** are additional variables shared across the PMM Defaults. + + === "File-Specific Template Variables" + + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Screen Actors Guild <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Screen Actors Guild Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + === "Shared Template Variables" + + {% + include-markdown "../collection_variables.md" + %} + +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: sag + template_variables: + collection_mode: show_items #(1)! + collection_order: alpha #(2)! + radarr_add_missing: true #(3)! + name_format: Screen Actors Guild <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest + ``` + + 1. Shows the collection and all of its items within the Library tab in Plex + 2. Sorts the collection items alphabetically + 3. Adds items from the source list which are not in Plex to Radarr + 4. Change the name of the collections to "Screen Actors Guild yearhere Winners" + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/separator.md b/docs/defaults/award/separator.md index 019dd0c8..308d455b 100644 --- a/docs/defaults/award/separator.md +++ b/docs/defaults/award/separator.md @@ -30,35 +30,36 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored. +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. -**[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.** +??? abstract "Variable Lists (click to expand)" -This file contains only a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). -### Example Template Variable Amendments + === "Shared Separator Variables" -The below is an example config.yml extract with some Template Variables added in to change how the file works. + {% + include-markdown "../separator_variables.md" + %} -???+ tip +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. -```yaml -libraries: - Movies: - collection_files: - - pmm: separator_award - template_variables: - sep_style: purple #(1)! -``` - -1. Use the purple [Separator Style](../separators.md#separator-styles) + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml + libraries: + Movies: + collection_files: + - pmm: separator_award + template_variables: + sep_style: purple #(1)! + ``` + 1. Use the purple [Separator Style](../separators.md#separator-styles) diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index c456a19e..5a56bd1d 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -8,8 +8,6 @@ The `spirit` Default Collection File is used to create collections based on the Supported Library Types: Movie -Requirements: [Trakt Authentication](../../config/trakt.md) - ## Collections Section 130 | Collection | Key | Description | @@ -30,32 +28,35 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" - | Variable | Description & Values | - |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | - | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | - | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Independent Spirit Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Independent Spirit Awards.`<br>**Values:** Any string with `<<key_name>>` in it. | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Independent Spirit Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Independent Spirit Awards.`<br>**Values:** Any string with `<<key_name>>` in it. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -63,17 +64,11 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments +???+ example "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. + Click the :fontawesome-solid-circle-plus: icon to learn more ```yaml libraries: @@ -85,14 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want collection_order: alpha #(2)! radarr_add_missing: true #(3)! name_format: Independent Spirit Awards <<key_name>> Winners #(4)! - data: - starting: latest-10 #(5)! - ending: latest #(6)! + data: #(5)! + starting: latest-10 + ending: latest ``` 1. Shows the collection and all of its items within the Library tab in Plex 2. Sorts the collection items alphabetically 3. Adds items from the source list which are not in Plex to Radarr 4. Change the name of the collections to "Independent Spirit Awards yearhere Winners" - 5. If today is 2024, then create collections for Independent Spirit Awards 2014 onwards - 6. If today is 2024, then the final collection is Independent Spirit Awards 2024 + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index b2c492a7..7b60bded 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -8,8 +8,6 @@ The `sundance` Default Collection File is used to create collections based on t Supported Library Types: Movie -Requirements: [Trakt Authentication](../../config/trakt.md) - ## Collections Section 130 | Collection | Key | Description | @@ -30,32 +28,35 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" - | Variable | Description & Values | - |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | - | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | - | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | - | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | - | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | - | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival of <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival of <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -63,18 +64,11 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more ```yaml libraries: @@ -86,14 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want collection_order: alpha #(2)! radarr_add_missing: true #(3)! name_format: Sundance Film Festival <<key_name>> Winners #(4)! - data: - starting: latest-10 #(5)! - ending: latest #(6)! + data: #(5)! + starting: latest-10 + ending: latest ``` 1. Shows the collection and all of its items within the Library tab in Plex 2. Sorts the collection items alphabetically 3. Adds items from the source list which are not in Plex to Radarr 4. Change the name of the collections to "Sundance Film Festival yearhere Winners" - 5. If today is 2024, then create collections for Sundance Film Festival 2014 onwards - 6. If today is 2024, then the final collection is Sundance Film Festival 2024 \ No newline at end of file + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/tiff.md b/docs/defaults/award/tiff.md new file mode 100644 index 00000000..10999c8d --- /dev/null +++ b/docs/defaults/award/tiff.md @@ -0,0 +1,93 @@ +# Toronto International Film Festival Awards Collections + +The `tiff` Default Collection File is used to create collections based on the Toronto International Film Festival +Awards. + +![](../images/tiff.png) + +## Requirements & Recommendations + +Supported Library Types: Movie + +## Collections Section 130 + +| Collection | Key | Description | +|:----------------------------------------------------------------------------------------------------------|:----------------------------------|:------------------------------------------------------------------------------------| +| `Toronto People's Choice Award Winners` | `best` | Collection of Toronto International Film Festival People's Choice Award Winners. | +| `Toronto International Film Festival <<year>>`<br>**Example:** `Toronto International Film Festival 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Toronto International Film Festival Award Winners for the given year. | + +## Config + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + collection_files: + - pmm: tiff +``` + +## Template Variables + +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `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. + +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Shared Template Variables** are additional variables shared across the PMM Defaults. + + === "File-Specific Template Variables" + + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Toronto International Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Toronto International Film Festival Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + === "Shared Template Variables" + + {% + include-markdown "../collection_variables.md" + %} + +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: tiff + template_variables: + collection_mode: show_items #(1)! + collection_order: alpha #(2)! + radarr_add_missing: true #(3)! + name_format: Toronto International Film Festival <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest + ``` + + 1. Shows the collection and all of its items within the Library tab in Plex + 2. Sorts the collection items alphabetically + 3. Adds items from the source list which are not in Plex to Radarr + 4. Change the name of the collections to "Toronto International Film Festival yearhere Winners" + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/award/venice.md b/docs/defaults/award/venice.md new file mode 100644 index 00000000..e06274b4 --- /dev/null +++ b/docs/defaults/award/venice.md @@ -0,0 +1,92 @@ +# Venice Film Festival Awards Collections + +The `venice` Default Collection File is used to create collections based on the Venice Film Festival Awards. + +![](../images/venice.png) + +## Requirements & Recommendations + +Supported Library Types: Movie + +## Collections Section 130 + +| Collection | Key | Description | +|:------------------------------------------------|:----------------------------------|:---------------------------------------------------------------------| +| `Venice Golden Lions` | `golden` | Collection of Venice Film Festival Golden Lions Award Winners. | +| `Venice <<year>>`<br>**Example:** `Venice 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Venice Film Festival Award Winners for the given year. | + +## Config + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + collection_files: + - pmm: venice +``` + +## Template Variables + +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `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. + +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Shared Template Variables** are additional variables shared across the PMM Defaults. + + === "File-Specific Template Variables" + + | Variable | Description & Values | + |:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `use_year_collections` | **Description:** Turn the individual year collections off.<br>**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"`)<br>**Values:** Any number | + | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> | + | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> | + | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | + | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Venice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | + | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Venice Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. | + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + === "Shared Template Variables" + + {% + include-markdown "../collection_variables.md" + %} + +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: venice + template_variables: + collection_mode: show_items #(1)! + collection_order: alpha #(2)! + radarr_add_missing: true #(3)! + name_format: Venice <<key_name>> Winners #(4)! + data: #(5)! + starting: latest-10 + ending: latest + ``` + + 1. Shows the collection and all of its items within the Library tab in Plex + 2. Sorts the collection items alphabetically + 3. Adds items from the source list which are not in Plex to Radarr + 4. Change the name of the collections to "Venice yearhere Winners" + 5. Creates collections from 10 award shows back to the latest award show. diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index 2b600274..e73c04b2 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -1,6 +1,7 @@ # Actor Collections -The `actor` Default Collection File is used to dynamically create collections based on the most popular actors/actresses in your library. +The `actor` Default Collection File is used to dynamically create collections based on the most popular actors/actresses +in your library. ## Requirements & Recommendations @@ -14,7 +15,7 @@ Supported Library Types: Movie, Show | `<<actor_name>>`<br>**Example:** `Frank Welker` | `<<actor_name>>`<br>**Example:** `Frank Welker` | Collection of Movies/Shows the actor is top billing in. | {% - include-markdown "../people.md" + include-markdown "../people.md" %} ## Config @@ -31,23 +32,25 @@ libraries: - pmm: actor ``` - ## Template Variables -Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy. - -Note that the `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. +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. -??? info "Click to expand" +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. - === "File-Specific Template Variables" +??? abstract "Variable Lists (click to expand)" - The below template variables are available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). + === "File-Specific Template Variables" + | Variable | Description & Values | |:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` | @@ -62,26 +65,21 @@ Note that the `template_variables:` section only needs to be used if you do want | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s with <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. | | `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> | | `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. | - - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. - + + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments +???+ example "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. + Click the :fontawesome-solid-circle-plus: icon to learn more ```yaml libraries: @@ -102,4 +100,5 @@ Note that the `template_variables:` section only needs to be used if you do want 2. Create 20 collections maximum 3. use the [diiivoy Color Style](#diiivoy-color-style) 4. Do not create an "Actors Collections" separator - 5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb + 5. There are two Richard Brooks, so use the 2nd + [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb diff --git a/docs/defaults/both/aspect.md b/docs/defaults/both/aspect.md index c8da3bcd..e8c695ca 100644 --- a/docs/defaults/both/aspect.md +++ b/docs/defaults/both/aspect.md @@ -38,19 +38,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -64,26 +67,27 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} + + === "Shared Separator Variables" - ### Example Template Variable Amendments + {% + include-markdown "../separator_variables.md" + %} + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -95,4 +99,4 @@ Note that the `template_variables:` section only needs to be used if you do want ``` 1. Do not create a "1.65 - Early Widescreen" collection - 2. Use the plum [Separator Style](../separators.md#separator-styles) \ No newline at end of file + 2. Use the plum [Separator Style](../separators.md#separator-styles) diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index 0bb474c5..c11d7c1c 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -1,6 +1,7 @@ # Audio Language Collections -The `audio_language` Default Collection File is used to dynamically create collections based on the audio languages available in your library. +The `audio_language` Default Collection File is used to dynamically create collections based on the audio languages +available in your library. ![](../images/audio_language.png) @@ -32,19 +33,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -60,26 +64,27 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Audio`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in the <<key_name>> Language.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} + + === "Shared Separator Variables" - ### Example Template Variable Amendments - - The below is an example config.yml extract with some Template Variables added in to change how the file works. + {% + include-markdown "../separator_variables.md" + %} - ???+ tip +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -99,7 +104,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. @@ -128,4 +134,4 @@ If you want to customize these values, use the methods described above. preserve-includer-indent=false start="key_name_override:" %} - ``` \ No newline at end of file + ``` diff --git a/docs/defaults/both/based.md b/docs/defaults/both/based.md index a0bf11f0..f7507119 100644 --- a/docs/defaults/both/based.md +++ b/docs/defaults/both/based.md @@ -1,6 +1,7 @@ # Based On... Collections -The `based` Default Collection File is used to create collections with items that are based on or inspired by various media outlets (such as Books or Video Games). +The `based` Default Collection File is used to create collections with items that are based on or inspired by various +media outlets (such as Books or Video Games). ![](../images/based.png) @@ -34,19 +35,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -60,20 +64,27 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + === "Shared Template Variables" -### Example Template Variable Amendments + {% + include-markdown "../collection_variables.md" + %} + + === "Shared Separator Variables" -The below is an example config.yml extract with some Template Variables added in to change how the file works. + {% + include-markdown "../separator_variables.md" + %} -???+ tip +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -90,7 +101,8 @@ The below is an example config.yml extract with some Template Variables added in 1. Use the navy [Separator Style](../separators.md#separator-styles) 2. Do not create a "Based on a Comic" collection - 3. Make the "Based on a True Story" collection appear in the collection list before the other collections in this file + 3. Make the "Based on a True Story" collection appear in the collection list before the other collections in this + file 4. Pin the "Based on a Video Game" collection to the Recommended tab of the library 5. Pin the "Based on a Video Game" collection to the home screen of the server owner 6. Pin the "Based on a Video Game" collection to the home screen of other users of the server diff --git a/docs/defaults/both/collectionless.md b/docs/defaults/both/collectionless.md index 95988f1d..9b932cbe 100644 --- a/docs/defaults/both/collectionless.md +++ b/docs/defaults/both/collectionless.md @@ -1,6 +1,8 @@ # Collectionless Collection -The `collectionless` Default Collection File is used to create a [Collectionless collection](../../files/builders/plex.md#plex-collectionless) to help Show/Hide Movies/Shows properly in your library. +The `collectionless` Default Collection File is used to create a +[Collectionless collection](../../files/builders/plex.md#plex-collectionless) to help Show/Hide Movies/Shows properly in +your library. ![](../images/collectionless.png) @@ -8,7 +10,14 @@ The `collectionless` Default Collection File is used to create a [Collectionless Supported Library Types: Movie, Show -Requirements: For this file to work it needs to run last under `collection_files` and all other normal collections must use `collection_mode: hide_items` +Requirements: + +* This file needs to run last under `collection_files`. + +* All other normal collections must use `collection_mode: hide_items`. + +* Disable the `Minimum automatic collection size` option when using the `Plex Movie` Agent. (Use the +[`franchise` Default](../movie/franchise.md) for automatic collections) ## Collection @@ -36,51 +45,69 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored. +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. -**[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.** +??? abstract "Variable Lists (click to expand)" -| Variable | Description & Values | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `name_collectionless` | **Description:** Changes the name of the collection.<br>**Values:** New Collection Name | -| `summary_collectionless` | **Description:** Changes the summary of the collection.<br>**Values:** New Collection Summary | -| `sort_title` | **Description:** Sets the sort title for the collection.<br>**Default:** `~_Collectionless`<br>**Values:** Any String | -| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | -| `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image | -| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**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.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | | + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. -### Example Template Variable Amendments + ???+ warning -The below is an example config.yml extract with some Template Variables added in to change how the file works. + [Shared Collection Variables](../collection_variables.md) are NOT available to this default file. -```yaml -libraries: - Movies: - template_variables: - collection_mode: hide_items - collection_files: - - pmm: collectionless + === "File-Specific Template Variables" + + | Variable | Description & Values | + |:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `name_collectionless` | **Description:** Changes the name of the collection.<br>**Values:** New Collection Name | + | `summary_collectionless` | **Description:** Changes the summary of the collection.<br>**Values:** New Collection Summary | + | `sort_title` | **Description:** Sets the sort title for the collection.<br>**Default:** `~_Collectionless`<br>**Values:** Any String | + | `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | + | `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image | + | `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections | + | `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | | + +???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: template_variables: - exclude: - - Marvel Cinematic Universe - collection_order: release -``` + collection_mode: hide_items + collection_files: + - pmm: collectionless + template_variables: + exclude: + - Marvel Cinematic Universe + collection_order: release + ``` ## 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 `exclude_prefix` (click to expand) <a class="headerlink" href="#exclude-prefix" title="Permanent link">¶</a>" -### Default `exclude_prefix` + <div id="exclude-prefix" /> -```yaml -exclude_prefix: - - "!" - - "~" -``` \ No newline at end of file + ```yaml + {% + include-markdown "../../../defaults/both/collectionless.yml" + comments=false + preserve-includer-indent=true + dedent=true + start="# check1" + end="# check2" + %} + ``` diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index 1dab5bfd..3fc288ac 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -1,8 +1,10 @@ # Common Sense Media Content Rating Collections -The `content_rating_cs` Default Collection File is used to dynamically create collections based on the content ratings available in your library. +The `content_rating_cs` Default Collection File is used to dynamically create collections based on the content ratings +available in your library. -If you do not use the Common Sense-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system. +If you do not use the Common Sense-based rating system within Plex, this file will attempt to match the ratings in your +library to the respective rating system. ![](../images/content_rating_cs.png) @@ -10,15 +12,17 @@ If you do not use the Common Sense-based rating system within Plex, this file wi Supported Library Types: Movie, Show -Recommendations: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating. +Recommendations: Use the +[Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either +`mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating. ## Collections Section 110 -| Collection | Key | Description | -|:------------------------------------------------------------------|:---------------------------------|:----------------------------------------------------------------------------------------| -| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | -| `<<Content Rating>> Movies/Shows`<br>**Example:** `Age 5+ Movies` | `<<Number>>`<br>**Example:** `5` | Collection of Movies/Shows that have this Content Rating. | -| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. | +| Collection | Key | Description | +|:------------------------------------------------------------------|:---------------------------------|:--------------------------------------------------------------------------------------| +| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | +| `<<Content Rating>> Movies/Shows`<br>**Example:** `Age 5+ Movies` | `<<Number>>`<br>**Example:** `5` | Collection of Movies/Shows that have this Content Rating. | +| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. | ## Config @@ -36,19 +40,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -66,26 +73,27 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Age <<key_name>>+ <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>> accorfing to the Common Sense Rating System.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} + + === "Shared Separator Variables" - ### Example Template Variable Amendments + {% + include-markdown "../separator_variables.md" + %} + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -100,15 +108,16 @@ Note that the `template_variables:` section only needs to be used if you do want sort_by: title.asc ``` - 1. Use the blue [Separator Style](../separators.md#separator-styles) 2. Do not create a "Not Rated Movies/Shows" collection 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 + 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 -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. diff --git a/docs/defaults/both/content_rating_de.md b/docs/defaults/both/content_rating_de.md index c785cd6c..89b54211 100644 --- a/docs/defaults/both/content_rating_de.md +++ b/docs/defaults/both/content_rating_de.md @@ -1,8 +1,10 @@ # DE Content Rating Collections -The `content_rating_de` Default Collection File is used to dynamically create collections based on the content ratings available in your library. +The `content_rating_de` Default Collection File is used to dynamically create collections based on the content ratings +available in your library. -If you do not use the German-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system. +If you do not use the German-based rating system within Plex, this file will attempt to match the ratings in your +library to the respective rating system. ![](../images/content_rating_de.png) @@ -14,11 +16,11 @@ Recommendation: Set the Certification Country within your library's advanced set ## Collections Section 110 -| Collection | Key | Description | -|:------------------------------------------------------------------|:--------------------------------------------|:----------------------------------------------------------------------------------------| -| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | -| `<<Content Rating>> Movies/Shows`<br>**Example:** `BPjM Movies` | `<<Content Rating>>`<br>**Example:** `BPjM` | Collection of Movies/Shows that have this Content Rating. | -| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. | +| Collection | Key | Description | +|:----------------------------------------------------------------|:--------------------------------------------|:--------------------------------------------------------------------------------------| +| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | +| `<<Content Rating>> Movies/Shows`<br>**Example:** `BPjM Movies` | `<<Content Rating>>`<br>**Example:** `BPjM` | Collection of Movies/Shows that have this Content Rating. | +| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. | ## Config @@ -36,20 +38,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" - - The below template variables are available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -67,26 +71,27 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} + + === "Shared Separator Variables" - ### Example Template Variable Amendments - - The below is an example config.yml extract with some Template Variables added in to change how the file works. + {% + include-markdown "../separator_variables.md" + %} - ???+ tip +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -104,11 +109,13 @@ Note that the `template_variables:` section only needs to be used if you do want 1. Use the stb [Separator Style](../separators.md#separator-styles) 2. Do not create a "Not Rated Movies/Shows" collection 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 + 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 -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. @@ -137,4 +144,4 @@ If you want to customize these values, use the methods described above. preserve-includer-indent=false start="addons:" %} - ``` \ No newline at end of file + ``` diff --git a/docs/defaults/both/content_rating_mal.md b/docs/defaults/both/content_rating_mal.md index 8457c17b..b5e8fe75 100644 --- a/docs/defaults/both/content_rating_mal.md +++ b/docs/defaults/both/content_rating_mal.md @@ -1,8 +1,10 @@ # MAL Content Rating Collections -The `content_rating_mal` Default Collection File is used to dynamically create collections based on the content ratings available in your library. +The `content_rating_mal` Default Collection File is used to dynamically create collections based on the content ratings +available in your library. -If you do not use the MAL-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system. +If you do not use the MAL-based rating system within Plex, this file will attempt to match the ratings in your library +to the respective rating system. ![](../images/content_rating_mal.png) @@ -10,15 +12,17 @@ If you do not use the MAL-based rating system within Plex, this file will attemp Supported Library Types: Movie, Show -Recommendations: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with `mal` to update Plex to the MyAnimeList Content Rating. +Recommendations: Use the +[Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with `mal` to +update Plex to the MyAnimeList Content Rating. ## Collections Section 110 -| Collection | Key | Description | -|:----------------------------------------------------------------|:---------------------------------------------|:---------------------------------------------------------------------------------| -| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | -| `<<Content Rating>> Movies/Shows`<br>**Example:** `PG-13 Shows` | `<<Content Rating>>`<br>**Example:** `PG-13` | Collection of Shows that have this Content Rating. | -| `Not Rated Movies/Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. | +| Collection | Key | Description | +|:----------------------------------------------------------------|:---------------------------------------------|:-------------------------------------------------------------------------------| +| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | +| `<<Content Rating>> Movies/Shows`<br>**Example:** `PG-13 Shows` | `<<Content Rating>>`<br>**Example:** `PG-13` | Collection of Shows that have this Content Rating. | +| `Not Rated Movies/Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. | ## Config @@ -40,15 +44,24 @@ Template Variables can be used to manipulate the file in various ways to slightl 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. -??? info "Click to expand" +## Template Variables - === "File-Specific Template Variables" +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `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. - The below template variables are available specifically for this PMM Defaults file. +??? abstract "Variable Lists (click to expand)" - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. + + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). + + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -66,25 +79,26 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} + + === "Shared Separator Variables" -### Example Template Variable Amendments - -The below is an example config.yml extract with some Template Variables added in to change how the file works. + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" -???+ tip + The below is an example config.yml extract with some Template Variables added in to change how the file works. - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + Click the :fontawesome-solid-circle-plus: icon to learn more ```yaml libraries: @@ -102,12 +116,15 @@ The below is an example config.yml extract with some Template Variables added in 1. Use the tan [Separator Style](../separators.md#separator-styles) 2. Do not create a "Not Rated Movies/Shows" collection - 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 + 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 -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. diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index ced9125b..b122dc34 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -1,8 +1,10 @@ # UK Content Rating Collections -The `content_rating_uk` Default Collection File is used to dynamically create collections based on the content ratings available in your library. +The `content_rating_uk` Default Collection File is used to dynamically create collections based on the content ratings +available in your library. -If you do not use the UK-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system. +If you do not use the UK-based rating system within Plex, this file will attempt to match the ratings in your library to +the respective rating system. ![](../images/content_rating_uk.png) @@ -14,11 +16,11 @@ Recommendation: Set the Certification Country within your library's advanced set ## Collections Section 110 -| Collection | Key | Description | -|:--------------------------------------------------------------|:------------------------------------------|:----------------------------------------------------------------------------------------| -| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | -| `<<Content Rating>> Movies/Shows`<br>**Example:** `15 Movies` | `<<Content Rating>>`<br>**Example:** `15` | Collection of Movies/Shows that have this Content Rating. | -| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. | +| Collection | Key | Description | +|:--------------------------------------------------------------|:------------------------------------------|:--------------------------------------------------------------------------------------| +| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | +| `<<Content Rating>> Movies/Shows`<br>**Example:** `15 Movies` | `<<Content Rating>>`<br>**Example:** `15` | Collection of Movies/Shows that have this Content Rating. | +| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. | ## Config @@ -36,19 +38,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -66,26 +71,27 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} + + === "Shared Separator Variables" - ### Example Template Variable Amendments - - The below is an example config.yml extract with some Template Variables added in to change how the file works. + {% + include-markdown "../separator_variables.md" + %} - ???+ tip +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -103,11 +109,13 @@ Note that the `template_variables:` section only needs to be used if you do want 1. Use the stb [Separator Style](../separators.md#separator-styles) 2. Do not create a "Not Rated Movies/Shows" collection 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 + 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 -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. diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index 5908869f..3f74b3b3 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -33,19 +33,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -60,7 +63,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the genre <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -68,18 +72,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -96,14 +100,18 @@ Note that the `template_variables:` section only needs to be used if you do want ``` 1. Use the red [Separator Style](../separators.md#separator-styles) - 2. Do not create a "Politics" collection, and do not include it in any other collections that it may be in as part of an "include" - 3. Do not create a "News" collection, and do not include it in any other collections that it may be in as part of an "include" + 2. Do not create a "Politics" collection, and do not include it in any other collections that it may be in as part + of an "include" + 3. Do not create a "News" collection, and do not include it in any other collections that it may be in as part of + an "include" 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 + 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 -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. @@ -117,4 +125,5 @@ If you want to customize these values, use the methods described above. comments=false preserve-includer-indent=false start="addons:" - %} \ No newline at end of file + %} + ``` diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index d752da80..8f70262e 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -1,6 +1,7 @@ # Resolution Collections -The `resolution` Default Collection File is used to dynamically create collections based on the resolutions available in your library. +The `resolution` Default Collection File is used to dynamically create collections based on the resolutions available in +your library. ![](../images/resolution.png) @@ -17,9 +18,11 @@ Supported Library Types: Movie, Show ### Standards Style -Below is a screenshot of the alternative Standards (`standards`) style which can be set via the `style` template variable. +Below is a screenshot of the alternative Standards (`standards`) style which can be set via the `style` template +variable. -Standards Style takes the base resolutions ("4K" and "720p") and turns them into the commonly-known standards name ("Ultra HD" and "HD Ready") +Standards Style takes the base resolutions ("4K" and "720p") and turns them into the commonly-known standards name +("Ultra HD" and "HD Ready") ![](../images/resolution_standards.png) @@ -39,19 +42,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -70,26 +76,27 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} + + === "Shared Separator Variables" - ### Example Template Variable Amendments - - The below is an example config.yml extract with some Template Variables added in to change how the file works. + {% + include-markdown "../separator_variables.md" + %} - ???+ tip +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -107,7 +114,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. @@ -136,4 +144,4 @@ If you want to customize these values, use the methods described above. preserve-includer-indent=false start="addons:" %} - ``` \ No newline at end of file + ``` diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index 926c34ec..9ad342c1 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -1,6 +1,7 @@ # Streaming Collections -The `streaming` Default Collection File is used to dynamically create collections based on the streaming Services that your media is available on. +The `streaming` Default Collection File is used to dynamically create collections based on the streaming Services that +your media is available on. ![](../images/streaming.png) @@ -31,6 +32,18 @@ Supported Library Types: Movie, Show | `Prime Video Movies/Shows` | `amazon` | Collection of Movies/Shows Streaming on Prime Video. | | `Showtime Movies/Shows` | `showtime` | Collection of Movies/Shows Streaming on Showtime. | +## Regional Variants + +Some logic is applied to allow for regional streaming service lists to be available to users depending on where they +are, as detailed below: + +| Region | Key | Description | +|:-----------------|:---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| any besides `us` | `amazon`, `disney`, `netflix` | These collections will use regional variant lists to ensure the lists populate with what is available in the region specified | +| any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These collections will not be created if the region is not `uk` as these streaming services are UK-focused | +| any besides `ca` | `crave` | These collections will not be created if the region is not `ca` as these streaming services are Canada-focused | +| `ca` | `max`, `showtime` | These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada | + ## Config The below YAML in your config.yml will create the collections: @@ -47,19 +60,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -75,7 +91,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s streaming on <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -83,30 +100,18 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../collection_variables.md" %} -## Regional Variants - -Some logic is applied to allow for regional streaming service lists to be available to users depending on where they are, as detailed below: + === "Shared Separator Variables" -| Region | Key | Description | -|:-----------------|:---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| -| any besides `us` | `amazon`, `disney`, `netflix` | These collections will use regional variant lists to ensure the lists populate with what is available in the region specified | -| any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These collections will not be created if the region is not `uk` as these streaming services are UK-focused | -| any besides `ca` | `crave` | These collections will not be created if the region is not `ca` as these streaming services are Canada-focused | -| `ca` | `max`, `showtime` | These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada | - - -### 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 + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -130,4 +135,4 @@ The below is an example config.yml extract with some Template Variables added in 5. Pin the "Disney+ Movies/Shows" collection to the home screen of other users of the server 6. Add missing shows in your library from the "Hulu Shows" list to your Sonarr 7. Add missing movies in your library from the "Prime Video Movies" list to your Radarr - 8. Sort all the collections created by this file randomly \ No newline at end of file + 8. Sort all the collections created by this file randomly diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index 11382195..2eaed74c 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -1,8 +1,10 @@ # Studio Collections -The `studio` Default Collection File is used to dynamically create collections based on the studios available in your library. +The `studio` Default Collection File is used to dynamically create collections based on the studios available in your +library. -This file also merges similarly named studios (such as "20th Century Fox" and "20th Century Animation") into one ("20th Century Studios") +This file also merges similarly named studios (such as "20th Century Fox" and "20th Century Animation") into one ("20th +Century Studios") ![](../images/studio.png) @@ -33,19 +35,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -63,7 +68,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -71,18 +77,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -102,7 +108,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. @@ -131,4 +138,4 @@ If you want to customize these values, use the methods described above. preserve-includer-indent=false start="addons:" %} - ``` \ No newline at end of file + ``` diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index 23161c29..b38bdac6 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -1,6 +1,7 @@ # Subtitle Language Collections -The `subtitle_language` Default Collection File is used to dynamically create collections based on the subtitle languages available in your library. +The `subtitle_language` Default Collection File is used to dynamically create collections based on the subtitle +languages available in your library. ![](../images/subtitle_language.png) @@ -32,19 +33,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -60,7 +64,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Subtitles`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s with <<key_name>> Subtitles.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -68,19 +73,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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 + === "Shared Separator Variables" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -100,7 +104,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. @@ -129,4 +134,4 @@ If you want to customize these values, use the methods described above. preserve-includer-indent=false start="key_name_override:" %} - ``` \ No newline at end of file + ``` diff --git a/docs/defaults/both/universe.md b/docs/defaults/both/universe.md index ffde0cab..f6795afd 100644 --- a/docs/defaults/both/universe.md +++ b/docs/defaults/both/universe.md @@ -1,6 +1,7 @@ # Universe Collections -The `universe` Default Collection File is used to create collections based on popular Movie universes (such as the Marvel Cinematic Universe or Wizarding World). +The `universe` Default Collection File is used to create collections based on popular Movie universes (such as the +Marvel Cinematic Universe or Wizarding World). ![](../images/universe.png) @@ -45,19 +46,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -75,7 +79,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `remove_data` | **Description:** Removes from the [default data dictionary](#data).<br>**Values:** List of keys to remove | | `exclude` | **Description:** Exclude these Universes from creating a Dynamic Collection.<br>**Values:** List of Universes | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -83,19 +88,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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 + === "Shared Separator Variables" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -118,7 +122,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. @@ -141,12 +146,13 @@ If you want to customize these values, use the methods described above. <div id="trakt-url" /> ```yaml - trakt_url: {% + {% include-markdown "../../../defaults/both/universe.yml" comments=false - preserve-includer-indent=false + preserve-includer-indent=true + dedent=true start="# check1" - end="mdblist_url:" + end="# check2" %} ``` @@ -155,11 +161,12 @@ If you want to customize these values, use the methods described above. <div id="mdblist-url" /> ```yaml - mdblist_url: {% + {% include-markdown "../../../defaults/both/universe.yml" comments=false - preserve-includer-indent=false + preserve-includer-indent=true + dedent=true start="# check2" - end="image:" + end="# check3" %} ``` diff --git a/docs/defaults/both/year.md b/docs/defaults/both/year.md index 86dd2f18..01117bc0 100644 --- a/docs/defaults/both/year.md +++ b/docs/defaults/both/year.md @@ -1,6 +1,7 @@ # Year Collections -The `year` Default Collection File is used to dynamically create collections based on the years available in your library, sorted by critic rating to create a "best of <year>" +The `year` Default Collection File is used to dynamically create collections based on the years available in your +library, sorted by critic rating to create a "best of <year>" ![](../images/year.png) @@ -31,19 +32,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -54,7 +58,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> current_year-10<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> current_year<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> | | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -62,35 +67,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" {% - include-markdown "../collection_variables.md" + include-markdown "../separator_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -104,4 +92,3 @@ Note that the `template_variables:` section only needs to be used if you do want 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 3762fd92..e2dbb209 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -33,17 +33,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" | Variable | Description & Values | |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -54,26 +56,21 @@ Note that the `template_variables:` section only needs to be used if you do want | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -88,10 +85,11 @@ Note that the `template_variables:` section only needs to be used if you do want visible_home_popular: true #(6)! visible_shared_popular: true #(7)! ``` + 1. Do not create the "AniList Season" collection 2. Change the order of "AniList Top Rated" to appear before other collections created by this file 3. Amend the summary of the "AniList Top Rated" collection 4. Only allow a maximum of 10 items to appear in the "AniList Top Rated" collection 5. Pin the "AniList Popular" collection to the Recommended tab of the library 6. Pin the "AniList Popular" collection to the home screen of the server owner - 7. Pin the "AniList Popular" collection to the home screen of other users of the server \ No newline at end of file + 7. Pin the "AniList Popular" collection to the home screen of other users of the server diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index 02b485c2..6db91348 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -31,17 +31,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" | Variable | Description & Values | |:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -51,26 +53,21 @@ Note that the `template_variables:` section only needs to be used if you do want | `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | | `in_the_last_<<key>>`<sup>1</sup> | **Description:** Changes how far back the Smart Filter looks.<table class="clearTable"><tr><td>**Default:**</td></tr><tr><td>`released`</td><td>`90`</td></tr><tr><td>`episodes`</td><td>`7`</td></tr></table>**Values:** Number greater than 0 | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -86,4 +83,4 @@ Note that the `template_variables:` section only needs to be used if you do want 1. Change the Smart Filter to look at episodes in the last 14 days. 2. Pin the "Newly Released" collection to the Recommended tab of the library 3. Pin the "Newly Released" collection to the home screen of the server owner - 4. Pin the "Newly Released" collection to the home screen of other users of the server \ No newline at end of file + 4. Pin the "Newly Released" collection to the home screen of other users of the server diff --git a/docs/defaults/chart/flixpatrol.md b/docs/defaults/chart/flixpatrol.md index a33db040..f1066a29 100644 --- a/docs/defaults/chart/flixpatrol.md +++ b/docs/defaults/chart/flixpatrol.md @@ -36,22 +36,24 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" - - The below template variables are available specifically for this PMM Defaults file. + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. ???+ warning 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. + === "File-Specific Template Variables" + | Variable | Description & Values | |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `10`<br>**Values:** Any Number 1-10 | @@ -65,26 +67,21 @@ Note that the `template_variables:` section only needs to be used if you do want | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index 05a84b63..f398515e 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -34,17 +34,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" | Variable | Description & Values | |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -53,26 +55,21 @@ Note that the `template_variables:` section only needs to be used if you do want | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -84,7 +81,8 @@ Note that the `template_variables:` section only needs to be used if you do want visible_home_top: true #(3)! visible_shared_top: true #(4)! ``` + 1. Do not create the "IMDb Lowest Rated" collection 2. Pin the "AniList Popular" collection to the Recommended tab of the library 3. Pin the "AniList Popular" collection to the home screen of the server owner - 4. Pin the "AniList Popular" collection to the home screen of other users of the server \ No newline at end of file + 4. Pin the "AniList Popular" collection to the home screen of other users of the server diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index 766db7a2..289a603f 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -34,17 +34,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" | Variable | Description & Values | |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -55,26 +57,21 @@ Note that the `template_variables:` section only needs to be used if you do want | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -94,4 +91,4 @@ Note that the `template_variables:` section only needs to be used if you do want 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 + 6. Pin the "MyAnimeList Popular" collection to the home screen of other users of the server diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 1c5ed397..49882802 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -35,17 +35,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" | Variable | Description & Values | |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -55,26 +57,21 @@ Note that the `template_variables:` section only needs to be used if you do want | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -86,7 +83,8 @@ Note that the `template_variables:` section only needs to be used if you do want visible_home_commonsense: true #(3)! visible_shared_commonsense: true #(4)! ``` + 1. Do not create the "AniDB Popular" collection 2. Pin the "Common Sense Selection" collection to the Recommended tab of the library 3. Pin the "Common Sense Selection" collection to the home screen of the server owner - 4. Pin the "Common Sense Selection" collection to the home screen of other users of the server \ No newline at end of file + 4. Pin the "Common Sense Selection" collection to the home screen of other users of the server diff --git a/docs/defaults/chart/separator.md b/docs/defaults/chart/separator.md index c30e6dff..3e4a2687 100644 --- a/docs/defaults/chart/separator.md +++ b/docs/defaults/chart/separator.md @@ -30,33 +30,36 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored. +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. -**[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.** +??? abstract "Variable Lists (click to expand)" -This file contains only a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). -### Example Template Variable Amendments + === "Shared Separator Variables" -The below is an example config.yml extract with some Template Variables added in to change how the file works. + {% + include-markdown "../separator_variables.md" + %} -???+ tip +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. -```yaml -libraries: - Movies: - collection_files: - - pmm: separator_chart - template_variables: - sep_style: purple #(1)! -``` + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: separator_chart + template_variables: + sep_style: purple #(1)! + ``` -1. Use the purple [Separator Style](../separators.md#separator-styles) \ No newline at end of file + 1. Use the purple [Separator Style](../separators.md#separator-styles) diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 80ec604c..82faf3b7 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -33,17 +33,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" | Variable | Description & Values | |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -63,19 +65,13 @@ Note that the `template_variables:` section only needs to be used if you do want {% include-markdown "../collection_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index cdb312c9..4a263e53 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -36,17 +36,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" | Variable | Description & Values | |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -57,26 +59,21 @@ Note that the `template_variables:` section only needs to be used if you do want | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -94,4 +91,4 @@ Note that the `template_variables:` section only needs to be used if you do want 2. Change "TMDb Popular" to have a maximum of 20 items 3. Pin the "TMDb Popular" collection to the Recommended tab of the library 4. Pin the "TMDb Popular" collection to the home screen of the server owner - 5. Pin the "TMDb Popular" collection to the home screen of other users of the server \ No newline at end of file + 5. Pin the "TMDb Popular" collection to the home screen of other users of the server diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index 73a1e764..b2bfb2ad 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -37,17 +37,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + === "File-Specific Template Variables" | Variable | Description & Values | |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -65,19 +67,13 @@ Note that the `template_variables:` section only needs to be used if you do want {% include-markdown "../collection_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: diff --git a/docs/defaults/collection_list.md b/docs/defaults/collection_list.md index f592c97b..817b9da1 100644 --- a/docs/defaults/collection_list.md +++ b/docs/defaults/collection_list.md @@ -1,107 +1,109 @@ ## Collections -These files can generally be used on both Movie and Show library-types, or are part of a category of collection (such as Award Shows.) +These files can generally be used on both Movie and Show library-types, or are part of a category of collection (such as +Award Shows.) These collections are applied by calling the below paths into the `collection_files` section of your config.yml ### Award Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:---------------------------------------------------|:------------------|:--------------------------------------------|:------------------------------------------------------:|:------------------------------------------------------:| -| [Award Separator](award/separator.md) | `separator_award` | Award Collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Academy Awards (Oscars)](award/oscars.md) | `oscars` | Best Picture Winners | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [British Academy of Film Awards](award/bafta.md) | `bafta` | BAFTA Best Films, BAFTA 2021 | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } | -| [Cannes Film Festival Awards](award/cannes.md) | `cannes` | Cannes - Palme d'or, Cannes 2018 | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } | -| [Critics Choice Awards](award/choice.md) | `choice` | Critics Choice Awards 2020 | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | -| [Emmy Awards](award/emmy.md) | `emmy` | Emmys 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Golden Globe Awards](award/golden.md) | `golden` | Best Motion Pictures | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Independent Spirit Awards](award/spirit.md) | `spirit` | Independent Spirit Awards 2021 | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } | -| [Sundance Film Festival Awards](award/sundance.md) | `sundance` | Sundance Grand Jury Winners | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } | -| [Other Awards](award/other.md) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } | - -<sup>1</sup> Requires [Trakt Authentication](../config/trakt.md) +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:----------------------------------------------------------------|:------------------|:-------------------------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:| +| [Award Separator](award/separator.md) | `separator_award` | Award Collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Academy Awards (Oscars)](award/oscars.md) | `oscars` | Oscars Best Picture Winners, Oscars Best Director Winners, Oscars 2022 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [Berlin International Film Festival Awards](award/berlinale.md) | `berlinale` | Berlinale Golden Bears, Berlinale 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [British Academy of Film Awards](award/bafta.md) | `bafta` | BAFTA Best Films, BAFTA 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [Cannes Film Festival Awards](award/cannes.md) | `cannes` | Cannes Golden Palm Winners, Cannes 2018 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [César Awards](award/cesar.md) | `cesar` | César Best Film Winners, César 2018 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [Critics Choice Awards](award/choice.md) | `choice` | Critics Choice Best Picture Winners, Critics Choice Awards 2020 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Emmy Awards](award/emmy.md) | `emmy` | Emmys Best in Category Winners, Emmys 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Golden Globe Awards](award/golden.md) | `golden` | Golden Globes Best Picture Winners, Golden Globes Best Director Winners, Golden Globe 2019 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Independent Spirit Awards](award/spirit.md) | `spirit` | Spirit Best Feature Winners, Independent Spirit Awards 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [National Film Registry](award/nfr.md) | `nfr` | National Film Registry All Time, National Film Registry 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [People's Choice Awards](award/pca.md) | `pca` | People's Choice Award Winners, People's Choice Awards 2022 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Razzie Awards](award/razzie.md) | `razzie` | Razzies Golden Raspberry Winners, Razzie 2023 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [Screen Actors Guild Awards](award/sag.md) | `sag` | Screen Actors Guild Award Winners, Screen Actors Guild 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Sundance Film Festival Awards](award/sundance.md) | `sundance` | Sundance Grand Jury Winners, Sundance Film Festival 2017 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [Toronto International Film Festival Awards](award/tiff.md) | `tiff` | Toronto People's Choice Award, Toronto International Film Festival 2020 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [Venice Film Festival Awards](award/venice.md) | `venice` | Venice Golden Lions, Venice 2023 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | ### Chart Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-------------------------------------------|:------------------|:-------------------------------------------|:------------------------------------------------------:|:------------------------------------------------------:| -| [Chart Separator](chart/separator.md) | `separator_chart` | Chart Collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Basic Charts](chart/basic.md) | `basic` | Newly Released, New Episodes | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Tautulli Charts](chart/tautulli.md) | `tautulli` | Plex Popular, Plex Watched | :fontawesome-solid-circle-check:{ .green }<sup>2</sup> | :fontawesome-solid-circle-check:{ .green }<sup>2</sup> | -| [IMDb Charts](chart/imdb.md) | `imdb` | IMDb Popular, IMDb Top 250 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [TMDb Charts](chart/tmdb.md) | `tmdb` | TMDb Popular, TMDb Airing Today | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Trakt Charts](chart/trakt.md) | `trakt` | Trakt Popular, Trakt Trending | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | -| [FlixPatrol Charts](chart/flixpatrol.md) | `flixpatrol` | Top Disney, Top Max, Top Hulu, Top Netflix | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [AniList Charts](chart/anilist.md) | `anilist` | AniList Popular, AniList Season | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [MyAnimeList Charts](chart/myanimelist.md) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Other Charts](chart/other.md) | `other_chart` | AniDB Popular, Common Sense Selection | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-------------------------------------------------|:------------------|:-------------------------------------------|:------------------------------------------:|:------------------------------------------:| +| [Chart Separator](chart/separator.md) | `separator_chart` | Chart Collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Basic Charts](chart/basic.md) | `basic` | Newly Released, New Episodes | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Tautulli Charts](chart/tautulli.md)<sup>1</sup> | `tautulli` | Plex Popular, Plex Watched | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [IMDb Charts](chart/imdb.md) | `imdb` | IMDb Popular, IMDb Top 250 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [TMDb Charts](chart/tmdb.md) | `tmdb` | TMDb Popular, TMDb Airing Today | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Trakt Charts](chart/trakt.md)<sup>2</sup> | `trakt` | Trakt Popular, Trakt Trending | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [FlixPatrol Charts](chart/flixpatrol.md) | `flixpatrol` | Top Disney, Top Max, Top Hulu, Top Netflix | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [AniList Charts](chart/anilist.md) | `anilist` | AniList Popular, AniList Season | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [MyAnimeList Charts](chart/myanimelist.md) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Other Charts](chart/other.md) | `other_chart` | AniDB Popular, Common Sense Selection | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -<sup>1</sup> Requires [Trakt Authentication](../config/trakt.md) +<sup>1</sup> Requires [Tautulli Authentication](../config/tautulli.md) -<sup>2</sup> Requires [Tautulli Authentication](../config/tautulli.md) +<sup>2</sup> Requires [Trakt Authentication](../config/trakt.md) ### Content Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-----------------------------------------------------------------|:------------|:--------------------------------------------|:---------------------------------------------------:|:--------------------------------------------------:| -| [Genres](both/genre.md) | `genre` | Action, Drama, Science Fiction | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| Franchises [Movie](movie/franchise.md)/[Show](show/franchise.md) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Universes](both/universe.md) | `universe` | Marvel Cinematic Universal, Wizarding World | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Based On...](both/based.md) | `based` | Based on a Book, Based on a True Story | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-----------------------------------------------------------------|:-----------------|:--------------------------------------------|:------------------------------------------:|:------------------------------------------:| +| [Genres](both/genre.md) | `genre` | Action, Drama, Science Fiction | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Franchises [Movie](movie/franchise.md)/[Show](show/franchise.md) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Universes](both/universe.md) | `universe` | Marvel Cinematic Universal, Wizarding World | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Based On...](both/based.md) | `based` | Based on a Book, Based on a True Story | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Collectionless](both/collectionless.md) | `collectionless` | Collectionless | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | ### Content Rating Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-----------------------------------------------------------------------------------------|:---------------------|:---------------------------------|:---------------------------------------------------:|:--------------------------------------------------:| -| US Content Ratings [Movie](movie/content_rating_us.md)/[Show](show/content_rating_us.md) | `content_rating_us` | G, PG, NC-17 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [UK Content Ratings](both/content_rating_uk.md) | `content_rating_uk` | U, PG, 12A | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [MyAnimeList Content Ratings](both/content_rating_mal.md) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Common Sense Media Content Ratings](both/content_rating_cs.md) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-----------------------------------------------------------------------------------------|:---------------------|:---------------------------------|:------------------------------------------:|:------------------------------------------:| +| US Content Ratings [Movie](movie/content_rating_us.md)/[Show](show/content_rating_us.md) | `content_rating_us` | G, PG, NC-17 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [UK Content Ratings](both/content_rating_uk.md) | `content_rating_uk` | U, PG, 12A | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [DE Content Ratings](both/content_rating_de.md) | `content_rating_de` | Films 12, Films 16, Films 18 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [MyAnimeList Content Ratings](both/content_rating_mal.md) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Common Sense Media Content Ratings](both/content_rating_cs.md) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | ### Location Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-----------------------------------------------------------------|:------------|:----------------------|:---------------------------------------------------:|:--------------------------------------------------:| -| Countries [Movie](movie/country.md)/[Show](show/country.md) | `country` | Belgium, India | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| Regions [Movie](movie/region.md)/[Show](show/region.md) | `region` | Iberia, Balkans | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| Continents [Movie](movie/continent.md)/[Show](show/continent.md) | `continent` | Asia, North America | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-----------------------------------------------------------------|:------------|:----------------------|:------------------------------------------:|:------------------------------------------:| +| Countries [Movie](movie/country.md)/[Show](show/country.md) | `country` | Belgium, India | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Regions [Movie](movie/region.md)/[Show](show/region.md) | `region` | Iberia, Balkans | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Continents [Movie](movie/continent.md)/[Show](show/continent.md) | `continent` | Asia, North America | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | ### Media Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:------------------------------------------------|:--------------------|:-------------------------------------|:---------------------------------------------------:|:--------------------------------------------------:| -| [Aspect Ratios](both/aspect.md) | `aspect` | 1.33, 1.65, 1.78, 1.85, 2.77 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Resolutions](both/resolution.md) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Audio Languages](both/audio_language.md) | `audio_language` | French Audio, Korean Audio | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Subtitle Languages](both/subtitle_language.md) | `subtitle_language` | German Subtitles, Swedish Subtitles | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:------------------------------------------------|:--------------------|:-------------------------------------|:------------------------------------------:|:------------------------------------------:| +| [Aspect Ratios](both/aspect.md) | `aspect` | 1.33, 1.65, 1.78, 1.85, 2.77 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Resolutions](both/resolution.md) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Audio Languages](both/audio_language.md) | `audio_language` | French Audio, Korean Audio | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Subtitle Languages](both/subtitle_language.md) | `subtitle_language` | German Subtitles, Swedish Subtitles | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | ### Production Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-------------------------------|:------------|:-----------------------------------------|:---------------------------------------------------:|:--------------------------------------------------:| -| [Networks](show/network.md) | `network` | Disney Channel, Lifetime | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| [Streaming](both/streaming.md) | `streaming` | Disney+ Movies, Max Shows | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Studios](both/studio.md) | `studio` | DreamWorks Studios, Walt Disney Pictures | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-------------------------------|:------------|:-----------------------------------------|:------------------------------------------:|:------------------------------------------:| +| [Networks](show/network.md) | `network` | Disney Channel, Lifetime | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | +| [Streaming](both/streaming.md) | `streaming` | Disney+ Movies, Max Shows | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Studios](both/studio.md) | `studio` | DreamWorks Studios, Walt Disney Pictures | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | ### People Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-------------------------------|:-----------|:-------------------------------------------------------|:---------------------------------------------------:|:--------------------------------------------------:| -| [Actors](both/actor.md) | `actor` | Chris Hemsworth, Margot Robbie | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Directors](movie/director.md) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [Producers](movie/producer.md) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [Writers](movie/writer.md) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-------------------------------|:-----------|:-------------------------------------------------------|:------------------------------------------:|:------------------------------------------:| +| [Actors](both/actor.md) | `actor` | Chris Hemsworth, Margot Robbie | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Directors](movie/director.md) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [Producers](movie/producer.md) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [Writers](movie/writer.md) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | ### Time Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:--------------------------------------------------------|:-----------|:---------------------------|:---------------------------------------------------:|:--------------------------------------------------:| -| [Seasonal](movie/seasonal.md) | `seasonal` | Easter, Christmas | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [Years](both/year.md) | `year` | Best of 2010, Best of 2019 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| Decades [Movie](movie/decade.md)/[Show](show/decade.md) | `decade` | Best of 2012, Best of 2022 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - -### Utility Collections - -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-----------------------------------------|:-----------------|:-------------------------|:---------------------------------------------------:|:--------------------------------------------------:| -| [Collectionless](both/collectionless.md) | `collectionless` | Collectionless | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:--------------------------------------------------------|:-----------|:---------------------------|:------------------------------------------:|:------------------------------------------:| +| [Seasonal](movie/seasonal.md) | `seasonal` | Easter, Christmas | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [Years](both/year.md) | `year` | Best of 2010, Best of 2019 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| Decades [Movie](movie/decade.md)/[Show](show/decade.md) | `decade` | Best of 2012, Best of 2022 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | diff --git a/docs/defaults/collection_variables.md b/docs/defaults/collection_variables.md index d9cfa2e3..495ea2a9 100644 --- a/docs/defaults/collection_variables.md +++ b/docs/defaults/collection_variables.md @@ -1,4 +1,3 @@ -The below shared template variables are available for this file. | Variable | Description & Values | |:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -54,4 +53,5 @@ The below shared template variables are available for this file. | `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags | | `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's collection.<br>**Default:** `item_sonarr_tag`<br>**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 `<<key>>` with when calling. \ No newline at end of file +1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with +when calling. \ No newline at end of file diff --git a/docs/defaults/images/berlinale.png b/docs/defaults/images/berlinale.png new file mode 100644 index 00000000..be3de6a3 Binary files /dev/null and b/docs/defaults/images/berlinale.png differ diff --git a/docs/defaults/images/cesar.png b/docs/defaults/images/cesar.png new file mode 100644 index 00000000..af273356 Binary files /dev/null and b/docs/defaults/images/cesar.png differ diff --git a/docs/defaults/images/nfr.png b/docs/defaults/images/nfr.png new file mode 100644 index 00000000..b27ff9d4 Binary files /dev/null and b/docs/defaults/images/nfr.png differ diff --git a/docs/defaults/images/pca.png b/docs/defaults/images/pca.png new file mode 100644 index 00000000..3d91e08c Binary files /dev/null and b/docs/defaults/images/pca.png differ diff --git a/docs/defaults/images/razzie.png b/docs/defaults/images/razzie.png new file mode 100644 index 00000000..e750f3e5 Binary files /dev/null and b/docs/defaults/images/razzie.png differ diff --git a/docs/defaults/images/sag.png b/docs/defaults/images/sag.png new file mode 100644 index 00000000..0e605e4d Binary files /dev/null and b/docs/defaults/images/sag.png differ diff --git a/docs/defaults/images/spirit.png b/docs/defaults/images/spirit.png index e1d1f80b..16edc808 100644 Binary files a/docs/defaults/images/spirit.png and b/docs/defaults/images/spirit.png differ diff --git a/docs/defaults/images/tiff.png b/docs/defaults/images/tiff.png new file mode 100644 index 00000000..20513b51 Binary files /dev/null and b/docs/defaults/images/tiff.png differ diff --git a/docs/defaults/images/venice.png b/docs/defaults/images/venice.png new file mode 100644 index 00000000..c9438d08 Binary files /dev/null and b/docs/defaults/images/venice.png differ diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index fc94a549..d82fc9b8 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -1,10 +1,12 @@ # US Content Rating Collections -The `content_rating_us` Default Collection File is used to dynamically create collections based on the content ratings available in your library. +The `content_rating_us` Default Collection File is used to dynamically create collections based on the content ratings +available in your library. -If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system. +If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to +the respective rating system. -**This file has a Show Library [Counterpart](../show/content_rating_us.md).** +**[This file has a Show Library Counterpart.](../show/content_rating_us.md)** ![](../images/moviecontent_rating_us.png) @@ -16,11 +18,11 @@ Recommendation: Set the Certification Country within your library's advanced set ## Collections Section 110 -| Collection | Key | Description | -|:-------------------------------------------------------|:-----------------------------------------|:----------------------------------------------------------------------------------| -| `Country Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | -| `<<Content Rating>> Movies`<br>**Example:** `R Movies` | `<<Content Rating>>`<br>**Example:** `R` | Collection of Movies that have this Content Rating. | -| `Not Rated Movies` | `other` | Collection of Movies that are Unrated, Not Rated or any other uncommon Ratings. | +| Collection | Key | Description | +|:-------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------| +| `Country Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | +| `<<Content Rating>> Movies`<br>**Example:** `R Movies` | `<<Content Rating>>`<br>**Example:** `R` | Collection of Movies that have this Content Rating. | +| `Not Rated Movies` | `other` | Collection of Movies that are Unrated, Not Rated or any other uncommon Ratings. | ## Config @@ -35,19 +37,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -65,7 +70,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -73,18 +79,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -102,11 +108,13 @@ Note that the `template_variables:` section only needs to be used if you do want 1. Use the blue [Separator Style](../separators.md#separator-styles) 2. Do not create a "Not Rated Movies" collection 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 + 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 -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. diff --git a/docs/defaults/movie/continent.md b/docs/defaults/movie/continent.md index 5d89f2a9..4a07ef40 100644 --- a/docs/defaults/movie/continent.md +++ b/docs/defaults/movie/continent.md @@ -1,8 +1,9 @@ # Continent Collections -The `continent` Default Collection File is used to dynamically create collections based on the countries within your library. The collection aims to be inclusive, with all 230 countries incorporated into seven continents. +The `continent` Default Collection File is used to dynamically create collections based on the countries within your +library. The collection aims to be inclusive, with all 230 countries incorporated into seven continents. -**This file has a Show Library [Counterpart](../show/continent.md).** +**[This file has a Show Library Counterpart.](../show/continent.md)** ![](../images/continent1.png) @@ -37,19 +38,22 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -69,7 +73,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -77,18 +82,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -110,7 +115,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index 09a580f8..96410279 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -1,8 +1,9 @@ # Country Collections -The `country` Default Collection File is used to dynamically create collections based on the countries available in your library. +The `country` Default Collection File is used to dynamically create collections based on the countries available in your +library. -**This file has a Show Library [Counterpart](../show/country.md).** +**[This file has a Show Library Counterpart.](../show/country.md)** ![](../images/country1.png) @@ -37,19 +38,22 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -69,7 +73,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -77,18 +82,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -110,7 +115,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index 7996034e..6c2cd8e8 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -1,8 +1,9 @@ # Decade Collections -The `decade` Default Collection File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>" +The `decade` Default Collection File is used to dynamically create collections based on the decades available in your +library, sorted by critic rating to create a "best of <decade>" -**This file works has a Show Library [Counterpart](../show/decade.md).** +**[This file has a Show Library Counterpart.](../show/decade.md)** ![](../images/decade.png) @@ -30,19 +31,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -54,7 +58,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Best of <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Top <<limit>> <<library_translation>>s of the <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -62,18 +67,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -86,4 +91,4 @@ Note that the `template_variables:` section only needs to be used if you do want ``` 1. Use the purple [Separator Style](../separators.md#separator-styles) - 2. Set the sort order for "Best of 2020s" to release date descending \ No newline at end of file + 2. Set the sort order for "Best of 2020s" to release date descending diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index 869058d8..b7f967bc 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -1,6 +1,7 @@ # Director Collections -The `director` Default Collection File is used to dynamically create collections based on the most popular directors in your library. +The `director` Default Collection File is used to dynamically create collections based on the most popular directors in +your library. ## Requirements & Recommendations @@ -14,7 +15,7 @@ Supported Library Types: Movie | `<<director_name>>`<br>**Example:** `Frank Welker` | `<<director_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by the Director. | {% - include-markdown "../people.md" + include-markdown "../people.md" %} ## Config @@ -30,19 +31,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -59,7 +63,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> | | `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -67,18 +72,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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 + === "Shared Separator Variables" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -98,4 +103,5 @@ Note that the `template_variables:` section only needs to be used if you do want 2. Create 20 collections maximum 3. use the [rainier Style](#rainier-style) 4. Do not create a "Directors Collections" separator - 5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb + 5. There are two Richard Brooks, so use the 2nd + [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 4eeef497..7c45f418 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -1,10 +1,13 @@ # Franchise Collections -The `franchise` Default Collection File is used to create collections based on popular Movie franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box. +The `franchise` Default Collection File is used to create collections based on popular Movie franchises, and can be used +as a replacement to the TMDb Collections that Plex creates out-of-the-box. -Unlike most Default Collection Files, Franchise works by placing collections inline with the main library items if your library allows it. For example, the "Iron Man" franchise collection will appear next to the "Iron Man" movies within your library. +Unlike most Default Collection Files, Franchise works by placing collections inline with the main library items if your +library allows it. For example, the "Iron Man" franchise collection will appear next to the "Iron Man" movies within +your library. -**This file has a Show Library [Counterpart](../show/franchise.md).** +**[This file has a Show Library Counterpart.](../show/franchise.md)** ![](../images/moviefranchise.png) @@ -31,17 +34,21 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + ???+ warning - **[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.** + [Shared Collection Variables](../collection_variables.md) are NOT available to this default file. + + === "File-Specific Template Variables" | Variable | Description & Values | |:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -73,21 +80,15 @@ Note that the `template_variables:` section only needs to be used if you do want | `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.<br>**Values:** List or comma-separated string of tags | | `item_radarr_tag_<<key>>`<sup>1</sup> | **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.<br>**Default:** `item_radarr_tag`<br>**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 `<<key>>` with when calling. - - - ### Example Template Variable Amendments + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + +???+ example "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. - + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -99,13 +100,17 @@ Note that the `template_variables:` section only needs to be used if you do want radarr_add_missing: true #(3)! ``` - 1. Do not create any physical collections in Plex (normally used when you want to perform an "operation" instead, see the third tooltip for the example) - 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! + 1. Do not create any physical collections in Plex (normally used when you want to perform an "operation" instead, + see the third tooltip for the example) + 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 -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. @@ -127,8 +132,6 @@ If you want to customize these values, use the methods described above. <div id="title-override" /> - **Default `title_override`**: - ```yaml title_override: {% include-markdown "../../../defaults/movie/franchise.yml" @@ -148,11 +151,13 @@ If you want to customize these values, use the methods described above. Pass `movie_<<key>>` to the file as template variables to change this value per collection. ```yaml - movie: {% + {% include-markdown "../../../defaults/movie/franchise.yml" comments=false + preserve-includer-indent=true + dedent=true start="# check1" - end="name_mapping:" + end="# check2" %} ``` @@ -165,10 +170,11 @@ If you want to customize these values, use the methods described above. Pass `name_mapping_<<key>>` 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 + preserve-includer-indent=true + dedent=true start="# check2" %} ``` diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index aafaf4c0..e02b6bea 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -1,6 +1,7 @@ # Producer Collections -The `producer` Default Collection File is used to dynamically create collections based on the most popular producers in your library. +The `producer` Default Collection File is used to dynamically create collections based on the most popular producers in +your library. ## Requirements & Recommendations @@ -14,7 +15,7 @@ Supported Library Types: Movie | `<<producer_name>>`<br>**Example:** `Frank Welker` | `<<producer_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by th Producer. | {% - include-markdown "../people.md" + include-markdown "../people.md" %} ## Config @@ -30,19 +31,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -59,7 +63,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> | | `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -67,18 +72,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -98,4 +103,5 @@ Note that the `template_variables:` section only needs to be used if you do want 2. Create 5 collections maximum 3. use the [rainier Style](#signature-style) 4. Do not create a "Producers Collections" separator - 5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb + 5. There are two Richard Brooks, so use the 2nd + [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb diff --git a/docs/defaults/movie/region.md b/docs/defaults/movie/region.md index 7e603758..e63b7077 100644 --- a/docs/defaults/movie/region.md +++ b/docs/defaults/movie/region.md @@ -1,8 +1,13 @@ # Region Collections -The `region` Default Collection File is used to dynamically create collections based on the countries within your library. The collection aims to be inclusive, with all 230 countries incorporated into 39 countries or collections of countries. Some care has been taken to ensure all countries are included, and the groupings won't fit well with everyone's collections. Western and Southern Europe, Oceania, and North America could be useful groupings for those libraries with more of an Asian focus, for instance. Please see the comments in the yml below where a decision point might be seen as controversial. You are welcome to edit this to fit your own audience's needs. +The `region` Default Collection File is used to dynamically create collections based on the countries within your +library. The collection aims to be inclusive, with all 230 countries incorporated into 39 countries or collections of +countries. Some care has been taken to ensure all countries are included, and the groupings won't fit well with +everyone's collections. Western and Southern Europe, Oceania, and North America could be useful groupings for those +libraries with more of an Asian focus, for instance. Please see the comments in the yml below where a decision point +might be seen as controversial. You are welcome to edit this to fit your own audience's needs. -**This file has a Show Library [Counterpart](../show/region.md).** +**[This file has a Show Library Counterpart.](../show/region.md)** ![](../images/region1.png) @@ -12,11 +17,11 @@ Supported Library Types: Movie ## Collections Section 081 -| Collection | Key | Description | -|:--------------------------------------|:----------------------------------------|:-------------------------------------------------------------------------------| -| `Region Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | -| `<<Region>>`<br>**Example:** `Nordic` | `<<Region>>`<br>**Example:** `Nordic` | Collection of Movies that have been tagged with countries in this region. | -| `Other Regions` | `other` | Collection of Movies that are in other uncommon Regions. | +| Collection | Key | Description | +|:--------------------------------------|:--------------------------------------|:-------------------------------------------------------------------------------| +| `Region Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | +| `<<Region>>`<br>**Example:** `Nordic` | `<<Region>>`<br>**Example:** `Nordic` | Collection of Movies that have been tagged with countries in this region. | +| `Other Regions` | `other` | Collection of Movies that are in other uncommon Regions. | ## Config @@ -37,19 +42,22 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -69,7 +77,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -77,18 +86,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -110,7 +119,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. diff --git a/docs/defaults/movie/seasonal.md b/docs/defaults/movie/seasonal.md index df8d0674..f44ae3c4 100644 --- a/docs/defaults/movie/seasonal.md +++ b/docs/defaults/movie/seasonal.md @@ -46,19 +46,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:--------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -85,7 +88,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `A collection of <<key_name>> <<library_translation>>s that may relate to the season.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. === "Shared Template Variables" @@ -93,18 +97,18 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments + === "Shared Separator Variables" - The below is an example config.yml extract with some Template Variables added in to change how the file works. - - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -127,11 +131,13 @@ Note that the `template_variables:` section only needs to be used if you do want 4. Create a new Seasonal collection called "Planet of the Apes Day", and set the key for this collection to `apes` 5. Set a scheduled range for the "Planet of the Apes Day" collection. Planet Of The Apes Day is 11/25. 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" + 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 -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. @@ -158,12 +164,13 @@ If you want to customize these values, use the methods described above. Pass `emoji_<<key>>` 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 + preserve-includer-indent=true + dedent=true start="# check1" - end="schedule:" + end="# check2" %} ``` @@ -176,12 +183,13 @@ If you want to customize these values, use the methods described above. Pass `schedule_<<key>>` to the file as template variables to change this value per collection. ```yaml - schedule: {% + {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false - preserve-includer-indent=false + preserve-includer-indent=true + dedent=true start="# check2" - end="imdb_list:" + end="# check3" %} ``` @@ -194,12 +202,13 @@ If you want to customize these values, use the methods described above. Pass `imdb_list_<<key>>` to the file as template variables to change this value per collection. ```yaml - imdb_list: {% + {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false - preserve-includer-indent=false + preserve-includer-indent=true + dedent=true start="# check3" - end="imdb_search:" + end="# check4" %} ``` @@ -212,12 +221,13 @@ If you want to customize these values, use the methods described above. Pass `imdb_search_<<key>>` to the file as template variables to change this value per collection. ```yaml - imdb_search: {% + {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false - preserve-includer-indent=false + preserve-includer-indent=true + dedent=true start="# check4" - end="tmdb_collection:" + end="# check5" %} ``` @@ -230,12 +240,13 @@ If you want to customize these values, use the methods described above. Pass `tmdb_collection_<<key>>` to the file as template variables to change this value per collection. ```yaml - tmdb_collection: {% + {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false - preserve-includer-indent=false + preserve-includer-indent=true + dedent=true start="# check5" - end="tmdb_movie:" + end="# check6" %} ``` @@ -248,12 +259,13 @@ If you want to customize these values, use the methods described above. Pass `tmdb_movie_<<key>>` to the file as template variables to change this value per collection. ```yaml - tmdb_movie: {% + {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false - preserve-includer-indent=false + preserve-includer-indent=true + dedent=true start="# check6" - end="mdblist_list:" + end="# check7" %} ``` @@ -266,12 +278,13 @@ If you want to customize these values, use the methods described above. Pass `mdblist_list_<<key>>` to the file as template variables to change this value per collection. ```yaml - mdblist_list: {% + {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false - preserve-includer-indent=false + preserve-includer-indent=true + dedent=true start="# check7" - end="trakt_list:" + end="# check8" %} ``` @@ -284,11 +297,12 @@ If you want to customize these values, use the methods described above. Pass `trakt_list_<<key>>` to the file as template variables to change this value per collection. ```yaml - trakt_list: {% + {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false - preserve-includer-indent=false + preserve-includer-indent=true + dedent=true start="# check8" - end="visible_home:" + end="# check9" %} ``` diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index f77716ec..fa24f453 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -1,6 +1,7 @@ # Writer Collections -The `writer` Default Collection File is used to dynamically create collections based on the most popular writers in your library. +The `writer` Default Collection File is used to dynamically create collections based on the most popular writers in your +library. ## Requirements & Recommendations @@ -14,7 +15,7 @@ Supported Library Types: Movie | `<<writer_name>>`<br>**Example:** `Frank Welker` | `<<writer_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by the Writer. | {% - include-markdown "../people.md" + include-markdown "../people.md" %} ## Config @@ -30,19 +31,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -59,29 +63,27 @@ Note that the `template_variables:` section only needs to be used if you do want | `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> | | `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. -{% - include-markdown "../collection_variables.md" -%} === "Shared Template Variables" {% include-markdown "../collection_variables.md" %} - ### Example Template Variable Amendments + === "Shared Separator Variables" - The below is an example config.yml extract with some Template Variables added in to change how the file works. - - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -101,4 +103,5 @@ Note that the `template_variables:` section only needs to be used if you do want 2. Create 20 collections maximum 3. use the [diivivoy Style](#rainier-style) 4. Do not create a "Writers Collections" separator - 5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb + 5. There are two Richard Brooks, so use the 2nd + [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb diff --git a/docs/defaults/overlay_list.md b/docs/defaults/overlay_list.md index 3e85307a..35c2ceee 100644 --- a/docs/defaults/overlay_list.md +++ b/docs/defaults/overlay_list.md @@ -1,12 +1,18 @@ ## Overlays -These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season and episode-level too. +These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season +and episode-level too. -It should be noted that when an overlay has :fontawesome-solid-circle-exclamation:{ .red } for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a commonsense age-rating since only Movies and Shows are rated by CommonSense. +It should be noted that when an overlay has :fontawesome-solid-circle-exclamation:{ .orange } for a season or episode, it +normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For +example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a common +sense age-rating since only Movies and Shows are rated by Common Sense. -In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data available will be applied at the lower level (i.e. a Show's CommonSense age rating would apply to all episodes). +In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data +available will be applied at the lower level (i.e. a Show's Common Sense age rating would apply to all episodes). -These overlays are applied by calling the below paths into the `overlay_files` [section](../config/files.md) of your config.yml +These overlays are applied by calling the below paths into the `overlay_files` [section](../config/files.md) of your +config.yml ### Chart Overlays @@ -26,22 +32,35 @@ These overlays are applied by calling the below paths into the `overlay_files` [ <sup>1</sup> Requires Template Variables to function +### Content Rating Overlays + +| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes | +|:------------------------------------------------------------------|:--------------------------|:------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| +| [US Content Ratings (Movie)](overlays/content_rating_us_movie.md) | `content_rating_us_movie` | G, PG, PG-13, R, NC-17, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | +| [US Content Ratings (Show)](overlays/content_rating_us_show.md) | `content_rating_us_show` | TV-G, TV-Y, TV-PG, TV-14, TV-MA, NR | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [UK Content Ratings](overlays/content_rating_uk.md) | `content_rating_uk` | U, PG, 12, 12a, 15, 18, R18, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [DE Content Ratings](overlays/content_rating_de.md) | `content_rating_de` | 0, 6, 12, 16, 18, BPjM, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Common Sense Age Rating](overlays/commonsense.md) | `commonsense` | 1+, 2+, 3+, 4+, ..., 17+, 18+, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | + +<sup>1</sup> Requires Template Variables to function + ### Media Overlays -| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes | -|:------------------------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:------------------------------------------:|:----------------------------------------------:|:----------------------------------------------:|:------------------------------------------:| -| [Aspect Ratio](overlays/aspect.md)<sup>1</sup> | `aspect` | "1.33","1.78" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Audio Codec](overlays/audio_codec.md)<sup>1</sup> | `audio_codec` | Dolby Atmos logo, DTS logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Audio/Subtitle Language Count](overlays/language_count.md) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Audio/Subtitle Language Flags](overlays/languages.md) | `languages` | Flags Based on the Audio/Subtitles a file has | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Resolution/Editions](overlays/resolution.md)<sup>2</sup> | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| [Runtimes](overlays/runtimes.md) | `runtimes` | "Runtime: 1h 30m" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| [Versions](overlays/versions.md) | `versions` | Multiple Versions logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [Video Format](overlays/video_format.md)<sup>1</sup> | `video_format` | "REMUX", "HDTV" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .red } | :fontawesome-solid-circle-exclamation:{ .red } | :fontawesome-solid-circle-check:{ .green } | +| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes | +|:------------------------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:------------------------------------------:|:-------------------------------------------------:|:-------------------------------------------------:|:------------------------------------------:| +| [Aspect Ratio](overlays/aspect.md)<sup>1</sup> | `aspect` | "1.33","1.78" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Audio Codec](overlays/audio_codec.md)<sup>1</sup> | `audio_codec` | Dolby Atmos logo, DTS logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Audio/Subtitle Language Count](overlays/language_count.md) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Audio/Subtitle Language Flags](overlays/languages.md) | `languages` | Flags Based on the Audio/Subtitles a file has | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Resolution/Editions](overlays/resolution.md)<sup>2</sup> | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | +| [Runtimes](overlays/runtimes.md) | `runtimes` | "Runtime: 1h 30m" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | +| [Versions](overlays/versions.md) | `versions` | Multiple Versions logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [Video Format](overlays/video_format.md)<sup>1</sup> | `video_format` | "REMUX", "HDTV" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-check:{ .green } | <sup>1</sup> Designed to use the [TRaSH Guides](https://trash-guides.info/) filename naming scheme -<sup>2</sup> Editions overlay is designed to use the Editions field within Plex [which requires Plex Pass to use] or the [TRaSH Guides](https://trash-guides.info/) filename naming scheme +<sup>2</sup> Editions overlay is designed to use the Editions field within Plex [which requires Plex Pass to use] or the +[TRaSH Guides](https://trash-guides.info/) filename naming scheme ### Production Overlays @@ -53,6 +72,6 @@ These overlays are applied by calling the below paths into the `overlay_files` [ ### Utility Overlays -| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes | -|:---------------------------------------|:--------------|:-------------------|:------------------------------------------:|:----------------------------------------------:|:----------------------------------------------:|:------------------------------------------:| -| [Direct Play](overlays/direct_play.md) | `direct_play` | "Direct Play Only" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .red } | :fontawesome-solid-circle-exclamation:{ .red } | :fontawesome-solid-circle-check:{ .green } | +| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes | +|:---------------------------------------|:--------------|:-------------------|:------------------------------------------:|:-------------------------------------------------:|:-------------------------------------------------:|:------------------------------------------:| +| [Direct Play](overlays/direct_play.md) | `direct_play` | "Direct Play Only" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-check:{ .green } | diff --git a/docs/defaults/overlay_text_variables.md b/docs/defaults/overlay_text_variables.md index d986f21f..b8cf7aee 100644 --- a/docs/defaults/overlay_text_variables.md +++ b/docs/defaults/overlay_text_variables.md @@ -1,4 +1,3 @@ -The below additional template variables are available for this PMM Defaults file as it is a text-based overlay. | Variable | Description & Values | |:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/defaults/overlay_variables.md b/docs/defaults/overlay_variables.md index 7fb8cac3..9a49a792 100644 --- a/docs/defaults/overlay_variables.md +++ b/docs/defaults/overlay_variables.md @@ -1,4 +1,3 @@ -The below additional template variables are available for this PMM Defaults file as it is an Overlay file. | Variable | Description & Values | |:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -24,4 +23,5 @@ The below additional template variables are available for this PMM Defaults file | `back_line_color` | **Description:** Controls the Backdrop Line Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA``AA` is transparency; 00 [transparent] to FF [opaque] | | `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.<br>**Values:** Any number greater than 0 | -1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. \ No newline at end of file +1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with +when calling. \ No newline at end of file diff --git a/docs/defaults/overlays/aspect.md b/docs/defaults/overlays/aspect.md index cfedfc8b..42a4b23b 100644 --- a/docs/defaults/overlays/aspect.md +++ b/docs/defaults/overlays/aspect.md @@ -43,11 +43,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + + * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -64,30 +72,30 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `text_<<key>>`<sup>1</sup> | **Description:** Choose the text for the Overlay.<br>**Default:** <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`1.33`</td><td>`1.33`</td></tr><tr><td>`1.65`</td><td>`1.65`</td></tr><tr><td>`1.66`</td><td>`1.66`</td></tr><tr><td>`1.78`</td><td>`1.78`</td></tr><tr><td>`1.85`</td><td>`1.85`</td></tr><tr><td>`2.2`</td><td>`2.2`</td></tr><tr><td>`2.35`</td><td>`2.35`</td></tr><tr><td>`2.77`</td><td>`2.77`</td></tr></table>**Values:** Any String | | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number | - === "Overlay Template Variables" + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. - {% - include-markdown "../overlay_text_variables.md" - %} + === "Overlay Template Variables" {% include-markdown "../overlay_variables.md" %} + === "Overlay Text Template Variables" - ### Example Template Variable Amendments + {% + include-markdown "../overlay_text_variables.md" + %} + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - + ```yaml libraries: Movies: @@ -112,4 +120,4 @@ Note that the `template_variables:` section only needs to be used if you do want overlay_level: season text_1.33: "4:9" text_1.77: "16:9" - ``` \ No newline at end of file + ``` diff --git a/docs/defaults/overlays/audio_codec.md b/docs/defaults/overlays/audio_codec.md index e34bb258..6695568b 100644 --- a/docs/defaults/overlays/audio_codec.md +++ b/docs/defaults/overlays/audio_codec.md @@ -1,6 +1,7 @@ # Audio Codec Overlay -The `audio_codec` Default Overlay File is used to create an overlay based on the audio codec available on each item within your library. +The `audio_codec` Default Overlay File is used to create an overlay based on the audio codec available on each item +within your library. ![](images/audio_codec.png) @@ -59,11 +60,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -80,10 +87,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------------------|:-------------------------------------------------------------------------------------------------------------| | `style` | **Description:** Choose the Overlay Style.<br>**Default:** `compact`<br>**Values:** `compact` or `standard` | @@ -91,18 +94,19 @@ Note that the `template_variables:` section only needs to be used if you do want | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number | | `regex_<<key>>`<sup>1</sup> | **Description:** Controls the regex of the Overlay Search.<br>**Values:** Any Proper Regex | - 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. === "Overlay Template Variables" {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/commonsense.md b/docs/defaults/overlays/commonsense.md index 0e2fd1b8..22bf5506 100644 --- a/docs/defaults/overlays/commonsense.md +++ b/docs/defaults/overlays/commonsense.md @@ -1,6 +1,7 @@ -# CommonSense Age Rating Overlay +# Common Sense Age Rating Overlay -The `commonsense` Default Overlay File is used to create an overlay based on the CommonSense Age Rating on each item within your library. +The `commonsense` Default Overlay File is used to create an overlay based on the Common Sense Age Rating on each item +within your library. ![](images/commonsense.png) @@ -8,9 +9,11 @@ The `commonsense` Default Overlay File is used to create an overlay based on the Supported library types: Movie & Show -Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating. +Requirements: Use the [Mass Content Rating Update Library +Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to +update Plex to the Common Sense Rating. -## Supported CommonSense Age Rating +## Supported Common Sense Age Rating | Rating | Key | |:-------|:-----| @@ -56,11 +59,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -77,10 +86,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------| | `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 | @@ -96,11 +101,11 @@ Note that the `template_variables:` section only needs to be used if you do want {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/content_rating_de.md b/docs/defaults/overlays/content_rating_de.md index 2c2b3d06..c5c026c4 100644 --- a/docs/defaults/overlays/content_rating_de.md +++ b/docs/defaults/overlays/content_rating_de.md @@ -1,6 +1,7 @@ # Content Rating DE Overlay -The `content_rating_de` Default Overlay File is used to create an overlay based on the FSK Rating on each item within your library. +The `content_rating_de` Default Overlay File is used to create an overlay based on the FSK Rating on each item within +your library. ![](images/content_rating_de.png) @@ -8,7 +9,9 @@ The `content_rating_de` Default Overlay File is used to create an overlay based Supported library types: Movie & Show -Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC Rating. +Requirements: Use the [Mass Content Rating Update Library +Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC +Rating. ## Supported Content Rating DE @@ -44,11 +47,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -62,31 +71,27 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - - | Variable | Description & Values | - |:------------------|:--------------------------------------------------------------------------------------------------------------------------------------------| - | `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. | - | `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` | - | `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` | - | `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` | - | `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` | - | `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 | - | `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` | - | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | + | Variable | Description & Values | + |:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------| + | `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. | + | `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` | + | `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` | + | `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` | + | `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` | + | `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 | + | `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` | + | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | === "Overlay Template Variables" {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/content_rating_uk.md b/docs/defaults/overlays/content_rating_uk.md index b64b4154..2f871574 100644 --- a/docs/defaults/overlays/content_rating_uk.md +++ b/docs/defaults/overlays/content_rating_uk.md @@ -1,6 +1,7 @@ # Content Rating UK Overlay -The `content_rating_uk` Default Overlay File is used to create an overlay based on the BBFC Age Rating on each item within your library. +The `content_rating_uk` Default Overlay File is used to create an overlay based on the BBFC Age Rating on each item +within your library. ![](images/content_rating_uk.png) @@ -8,7 +9,9 @@ The `content_rating_uk` Default Overlay File is used to create an overlay based Supported library types: Movie & Show -Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC Rating. +Requirements: Use the [Mass Content Rating Update Library +Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC +Rating. ## Supported Content Rating UK @@ -45,11 +48,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -63,31 +72,27 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - - | Variable | Description & Values | - |:------------------|:--------------------------------------------------------------------------------------------------------------------------------------------| - | `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. | - | `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` | - | `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` | - | `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` | - | `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` | - | `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 | - | `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` | - | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | + | Variable | Description & Values | + |:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------| + | `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. | + | `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` | + | `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` | + | `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` | + | `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` | + | `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 | + | `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` | + | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | === "Overlay Template Variables" {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/content_rating_us_movie.md b/docs/defaults/overlays/content_rating_us_movie.md index f1a78713..de9b61a1 100644 --- a/docs/defaults/overlays/content_rating_us_movie.md +++ b/docs/defaults/overlays/content_rating_us_movie.md @@ -1,6 +1,7 @@ # Content Rating US Movie Overlay -The `content_rating_us_movie` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each item within your library. +The `content_rating_us_movie` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each +item within your library. ![](images/content_rating_us_movie.png) @@ -8,7 +9,9 @@ The `content_rating_us_movie` Default Overlay File is used to create an overlay Supported library types: Movie -Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA Rating. +Requirements: Use the [Mass Content Rating Update Library +Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA +Rating. ## Supported Content Rating US @@ -34,11 +37,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -52,10 +61,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------| | `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. | @@ -71,11 +76,11 @@ Note that the `template_variables:` section only needs to be used if you do want {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/content_rating_us_show.md b/docs/defaults/overlays/content_rating_us_show.md index 0b97cb27..16e65abd 100644 --- a/docs/defaults/overlays/content_rating_us_show.md +++ b/docs/defaults/overlays/content_rating_us_show.md @@ -1,6 +1,7 @@ # Content Rating US Show Overlay -The `content_rating_us_show` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each item within your library. +The `content_rating_us_show` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each item +within your library. ![](images/content_rating_us_show.png) @@ -8,7 +9,9 @@ The `content_rating_us_show` Default Overlay File is used to create an overlay b Supported library types: Show -Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA Rating. +Requirements: Use the [Mass Content Rating Update Library +Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA +Rating. ## Supported Content Rating US @@ -40,11 +43,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -58,30 +67,26 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - - | Variable | Description & Values | - |:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. | - | `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` | - | `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` | - | `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` | - | `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` | - | `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 | - | `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` | + | Variable | Description & Values | + |:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------| + | `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. | + | `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` | + | `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` | + | `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` | + | `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` | + | `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 | + | `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` | === "Overlay Template Variables" {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - + ```yaml libraries: TV Shows: diff --git a/docs/defaults/overlays/direct_play.md b/docs/defaults/overlays/direct_play.md index 1f95e28d..7350438e 100644 --- a/docs/defaults/overlays/direct_play.md +++ b/docs/defaults/overlays/direct_play.md @@ -1,6 +1,7 @@ # Direct Play Overlay -The `direct_play` Default Overlay File is used to create an overlay to indicate items that cannot be transcoded and instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding) +The `direct_play` Default Overlay File is used to create an overlay to indicate items that cannot be transcoded and +instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding) ![](images/direct_play.png) @@ -24,11 +25,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + + * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -45,10 +54,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:----------------|:--------------------------------------------------------------------------------| | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | @@ -56,18 +61,19 @@ Note that the `template_variables:` section only needs to be used if you do want === "Overlay Template Variables" {% - include-markdown "../overlay_text_variables.md" + include-markdown "../overlay_variables.md" %} + === "Overlay Text Template Variables" + {% - include-markdown "../overlay_variables.md" + include-markdown "../overlay_text_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/episode_info.md b/docs/defaults/overlays/episode_info.md index 32da6d5e..a6cd761e 100644 --- a/docs/defaults/overlays/episode_info.md +++ b/docs/defaults/overlays/episode_info.md @@ -1,6 +1,7 @@ # Episode Info Overlay -The `episode_info` Default Overlay File is used to create an overlay on the episode title card on the episode numbering within a given series in your library. +The `episode_info` Default Overlay File is used to create an overlay on the episode title card on the episode numbering +within a given series in your library. ![](images/episode_info.png) @@ -21,11 +22,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + + * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -40,19 +47,22 @@ Note that the `template_variables:` section only needs to be used if you do want | `back_width` | `305` | | `back_height` | `105` | - {% - include-markdown "../overlay_text_variables.md" - %} + === "Overlay Template Variables" - {% - include-markdown "../overlay_variables.md" - %} + {% + include-markdown "../overlay_variables.md" + %} - ### Example Template Variable Amendments - - The below is an example config.yml extract with some Template Variables added in to change how the file works. + === "Overlay Text Template Variables" + {% + include-markdown "../overlay_text_variables.md" + %} + +???+ example "Example Template Variable Amendments" + The below is an example config.yml extract with some Template Variables added in to change how the file works. + ```yaml libraries: TV Shows: diff --git a/docs/defaults/overlays/flixpatrol.md b/docs/defaults/overlays/flixpatrol.md index 487825ee..bd807f1a 100644 --- a/docs/defaults/overlays/flixpatrol.md +++ b/docs/defaults/overlays/flixpatrol.md @@ -1,6 +1,7 @@ # FlixPatrol Top Overlays -The `flixpatrol` Default Overlay File is used to create an overlay based on the Top Lists from FlixPatrol on items within your library. +The `flixpatrol` Default Overlay File is used to create an overlay based on the Top Lists from FlixPatrol on items +within your library. ![](images/flixpatrol.png) @@ -36,11 +37,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + + * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -55,12 +64,12 @@ Note that the `template_variables:` section only needs to be used if you do want | `back_width` | `160` | | `back_height` | `160` | | `back_padding` | `15` | - - === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. + ???+ bug "Warning" - Be sure to also check out the "Overlay Template Variables" tab for additional variables. + `horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are NOT available for use in this file + + === "File-Specific Template Variables" | Variable | Description & Values | |:----------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -77,34 +86,25 @@ Note that the `template_variables:` section only needs to be used if you do want | `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `30`<br>**Values:** Any Number greater than 0 | | `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` | - 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. === "Overlay Template Variables" - {% - include-markdown "../overlay_text_variables.md" - %} - {% include-markdown "../overlay_variables.md" - end="Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored." %} - ???+ bug "Warning" - - `horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are NOT available for use in this file + === "Overlay Text Template Variables" {% - include-markdown "../overlay_variables.md" - start="The below template variables are available for this PMM Defaults file." + include-markdown "../overlay_text_variables.md" %} - - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/language_count.md b/docs/defaults/overlays/language_count.md index 535a4f22..252f9e22 100644 --- a/docs/defaults/overlays/language_count.md +++ b/docs/defaults/overlays/language_count.md @@ -1,6 +1,7 @@ # Audio/Subtitle Language Count Overlay -The `language_count` Default Overlay File is used to create an overlay based on the number of audio/subtitle languages available on each item within your library. +The `language_count` Default Overlay File is used to create an overlay based on the number of audio/subtitle languages +available on each item within your library. ![](images/language_count.png) @@ -37,11 +38,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -58,10 +65,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_subtitles` | **Description:** Controls if the overlay is based on subtitle language instead of audio language.<br>**Values:** `true` to look at subtitle language instead of audio language | @@ -69,19 +72,19 @@ Note that the `template_variables:` section only needs to be used if you do want | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number | - 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. === "Overlay Template Variables" {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/languages.md b/docs/defaults/overlays/languages.md index 2bd9b793..9f0125d8 100644 --- a/docs/defaults/overlays/languages.md +++ b/docs/defaults/overlays/languages.md @@ -1,6 +1,8 @@ # Audio/Subtitle Language Flags Overlay -The `languages` Default Overlay File is used to create an overlay of a flag and [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) based on the audio/subtitle languages available on each item within your library. +The `languages` Default Overlay File is used to create an overlay of a flag and [ISO 639-1 +Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) based on the audio/subtitle languages available on each +item within your library. ![](images/language.png) @@ -86,17 +88,17 @@ Supported library types: Movie & Show | Luxembourgish | `lb` | `2` | `lu` | :fontawesome-solid-circle-xmark:{ .red } | | Mossi | `mos` | `1` | `bf` | :fontawesome-solid-circle-xmark:{ .red } | -### Square Style +??? tip "Square Style (click to expand)" -Below is a screenshot of the alternative Square (`square`) style which can be set via the `style` template variable. + Below is a screenshot of the alternative Square (`square`) style which can be set via the `style` template variable. + + ![](images/language2.png) -![](images/language2.png) +??? tip "Half Style (click to expand)" -### Half Style - -Below is a screenshot of the alternative Half (`half`) style which can be set via the `style` template variable. - -![](images/language3.png) + Below is a screenshot of the alternative Half (`half`) style which can be set via the `style` template variable. + + ![](images/language3.png) ## Config @@ -120,11 +122,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults +work. Any value not specified will use its default value if it has one if not it's just ignored. + +??? abstract "Variable Lists (click to expand)" -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. + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. -??? info "Click to expand" + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + + * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -144,10 +154,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `languages` | **Description:** Controls which Languages will be active.<br>**Default:** `["en", "de", "fr", "es", "pt", "ja"]` <br>**Values:** List of [ISO 639-1 Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the Languages desired | @@ -165,23 +171,25 @@ Note that the `template_variables:` section only needs to be used if you do want | `country_<<key>>`<sup>1</sup> | **Description:** Controls the country image for the Overlay.<br>**Default:** Listed in the [Table](#supported-audiosubtitle-language-flags) above<br>**Values:** [ISO 3166-1 Country Code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) for the flag desired | | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number | - 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. === "Overlay Template Variables" {% - include-markdown "../overlay_text_variables.md" + include-markdown "../overlay_variables.md" %} + === "Overlay Text Template Variables" + {% - include-markdown "../overlay_variables.md" + include-markdown "../overlay_text_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/mediastinger.md b/docs/defaults/overlays/mediastinger.md index c694d6a3..9ee1db0c 100644 --- a/docs/defaults/overlays/mediastinger.md +++ b/docs/defaults/overlays/mediastinger.md @@ -1,6 +1,7 @@ # MediaStinger Overlay -The `mediastinger` Default Overlay File is used to create an overlay based on if there's an after/during credit scene on each movie within your library. +The `mediastinger` Default Overlay File is used to create an overlay based on if there's an after/during credit scene on +each movie within your library. ![](images/mediastinger.png) @@ -21,11 +22,15 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -40,15 +45,16 @@ Note that the `template_variables:` section only needs to be used if you do want | `back_width` | `105` | | `back_height` | `105` | - {% - include-markdown "../overlay_variables.md" - %} + === "Overlay Template Variables" - ### Example Template Variable Amendments + {% + include-markdown "../overlay_variables.md" + %} + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/network.md b/docs/defaults/overlays/network.md index 91017b51..4ed662ab 100644 --- a/docs/defaults/overlays/network.md +++ b/docs/defaults/overlays/network.md @@ -1,6 +1,7 @@ # Network Overlay -The `network` Default Overlay File is used to create an overlay based on the show network on each item within your library. +The `network` Default Overlay File is used to create an overlay based on the show network on each item within your +library. ![](images/Network_color.png) @@ -33,11 +34,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -54,10 +61,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:---------|:------------------------------------------------------------------------------------------------------------------| | `style` | **Description:** Choose between the default color version or the **white** one.<br>**Values:** `color` or `white` | @@ -67,12 +70,11 @@ Note that the `template_variables:` section only needs to be used if you do want {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: TV Shows: diff --git a/docs/defaults/overlays/ratings.md b/docs/defaults/overlays/ratings.md index 41d57ea3..460e37d5 100644 --- a/docs/defaults/overlays/ratings.md +++ b/docs/defaults/overlays/ratings.md @@ -1,10 +1,13 @@ # Ratings Overlays -The `ratings` Default Overlay File is used to create an overlay based on the Critic Rating, Audience Rating, and User Rating in Plex for each item within your library. +The `ratings` Default Overlay File is used to create an overlay based on the Critic Rating, Audience Rating, and User +Rating in Plex for each item within your library. -This file only updates the overlays based on the data in Plex, it will not pull the ratings directly from any third-party website, see recommendations below for more info. +This file only updates the overlays based on the data in Plex, it will not pull the ratings directly from any +third-party website, see recommendations below for more info. -**Please read [PMM Ratings Explained](../../pmm/guides/ratings.md) for more understanding on how PMM interacts with ratings.** +**Please read [PMM Ratings Explained](../../pmm/guides/ratings.md) for more understanding on how PMM interacts with +ratings.** ![](images/ratings_overlay.png) @@ -14,7 +17,8 @@ Supported Overlay Level: Movie, Show, Episode Requirements: Template Variables must be configured, otherwise this file will not apply any overlays. -Recommendations: Use the [Mass * Rating Update Library Operation](../../config/operations.md) and the [Mass Episode * Rating Update Library Operation](../../config/operations.md) to update Plex to the Ratings you want on the Overlay. +Recommendations: Use the [Mass * Rating Update Library Operation](../../config/operations.md) and the [Mass Episode * +Rating Update Library Operation](../../config/operations.md) to update Plex to the Ratings you want on the Overlay. ## Config @@ -62,11 +66,19 @@ The below YAML in your config.yml will create the overlays: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + + * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -85,15 +97,13 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - - These can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually. + These can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating + individually. ???+ warning - To amend `horizontal_offset` and `vertical_offset` you **must** prepend the variable with `rating1_`, `rating2_`, or `rating3_` + To amend `horizontal_offset` and `vertical_offset` you **must** prepend the variable with `rating1_`, + `rating2_`, or `rating3_` | Variable | Description & Values | |:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -119,23 +129,29 @@ Note that the `template_variables:` section only needs to be used if you do want | `addon_position`<sup>1</sup> | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` | | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `episode` | - 1. These Variables can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually. + 1. These variables can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each + rating individually. === "Overlay Template Variables" {% - include-markdown "../overlay_text_variables.md" + include-markdown "../overlay_variables.md" %} + === "Overlay Text Template Variables" + {% - include-markdown "../overlay_variables.md" + include-markdown "../overlay_text_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - **Note: This example uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)** + + ???+ warning + + This example uses fonts not packaged with PMM. See [bullmoose20's + Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20) ```yaml Movies: diff --git a/docs/defaults/overlays/resolution.md b/docs/defaults/overlays/resolution.md index f5094b65..3856c73f 100644 --- a/docs/defaults/overlays/resolution.md +++ b/docs/defaults/overlays/resolution.md @@ -1,6 +1,7 @@ # Resolution/Edition Overlay -The `resolution` Default Overlay File is used to create an overlay based on the resolutions and editions available on each item within your library. +The `resolution` Default Overlay File is used to create an overlay based on the resolutions and editions available on +each item within your library. ![](images/resolution.png) @@ -8,7 +9,8 @@ The `resolution` Default Overlay File is used to create an overlay based on the Supported Overlay Level: Movie, Show, Episode -Recommendations: Editions overlay is designed to use the Editions field within Plex [which requires Plex Pass to use] or the [TRaSH Guides](https://trash-guides.info/) filename naming scheme +Recommendations: Editions overlay is designed to use the Editions field within Plex [which requires Plex Pass to use] or +the [TRaSH Guides](https://trash-guides.info/) filename naming scheme ## Supported Resolutions @@ -88,7 +90,8 @@ In the PMM log, you may see references to versions of these overlays with `-Dove ... ``` -These `-Dovetail` variations are used when resolution and edition are combined so that one "dovetails" into the other. This is not something you can enable or disable independently; it's an internal implementation detail. +These `-Dovetail` variations are used when resolution and edition are combined so that one "dovetails" into the other. +This is not something you can enable or disable independently; it's an internal implementation detail. ## Config @@ -112,11 +115,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -133,10 +142,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------| | `use_resolution` | **Description:** Turns off all Resolution Overlays in the Defaults file.<br>**Values:** `false` to turn off the overlays | @@ -144,19 +149,19 @@ Note that the `template_variables:` section only needs to be used if you do want | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority. **Only works with Edition keys.**<br>**Values:** Any Number | - 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. === "Overlay Template Variables" {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/ribbon.md b/docs/defaults/overlays/ribbon.md index decb4ab3..7555825f 100644 --- a/docs/defaults/overlays/ribbon.md +++ b/docs/defaults/overlays/ribbon.md @@ -1,6 +1,7 @@ # Ribbon Overlays -The `ribbon` Default Overlay File is used to create a ribbon overlay based on the Top Lists of various sites on each item within your library. +The `ribbon` Default Overlay File is used to create a ribbon overlay based on the Top Lists of various sites on each +item within your library. ![](images/ribbon.png) @@ -28,7 +29,7 @@ Supported Overlay Level: Movie, Show | IMDb Top 250 | `imdb` | `50` | | Rotten Tomatoes Certified Fresh | `rotten` | `40` | | Metacritic Must See | `metacritic` | `30` | -| Commonsense Selection | `common` | `20` | +| Common Sense Selection | `common` | `20` | | Razzies Winner | `razzie` | `10` | ## Config @@ -47,11 +48,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -64,28 +71,25 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------------------|:------------------------------------------------------------------------------------------------------------------------| | `use_all` | **Description:** Used to turn on/off all keys. <br>**Default:** `true` <br>**Values:** `true` or `false` | | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number | | `style` | **Description:** Controls the color of the ribbon. <br>**Default:** `yellow` <br>**Values:** `yellow, gray, black, red` | - 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. === "Overlay Template Variables" {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/runtimes.md b/docs/defaults/overlays/runtimes.md index f2b90b18..fc1a7ae6 100644 --- a/docs/defaults/overlays/runtimes.md +++ b/docs/defaults/overlays/runtimes.md @@ -1,6 +1,7 @@ # Runtimes Overlay -The `runtimes` Default Overlay File is used to create an overlay of the movie runtime, episode runtime, or average episode runtime for all items in your library. +The `runtimes` Default Overlay File is used to create an overlay of the movie runtime, episode runtime, or average +episode runtime for all items in your library. ![](images/runtimes.png) @@ -27,11 +28,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + + * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -48,10 +57,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:----------|:-----------------------------------------------------------------------------------------------------------------------------------------| | `text` | **Description:** Choose the text that appears prior to the runtime on the Overlay.<br>**Default:** `Runtime: `<br>**Values:** Any String | @@ -59,18 +64,19 @@ Note that the `template_variables:` section only needs to be used if you do want === "Overlay Template Variables" {% - include-markdown "../overlay_text_variables.md" + include-markdown "../overlay_variables.md" %} + === "Overlay Text Template Variables" + {% - include-markdown "../overlay_variables.md" + include-markdown "../overlay_text_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: TV Shows: diff --git a/docs/defaults/overlays/status.md b/docs/defaults/overlays/status.md index 0c10a9e3..fb634a3b 100644 --- a/docs/defaults/overlays/status.md +++ b/docs/defaults/overlays/status.md @@ -1,6 +1,7 @@ # Status Overlay -The `status` Default Overlay File is used to create an overlay on a show detailing its Current Airing Status for all shows in your library. +The `status` Default Overlay File is used to create an overlay on a show detailing its Current Airing Status for all +shows in your library. ![](images/status.png) @@ -30,11 +31,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + + * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -51,33 +60,31 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `last` | **Description:** Episode Air Date in the last number of days for the AIRING Overlay.<br>**Default:** `14`<br>**Values:** Any number greater than 0 | | `text_<<key>>`<sup>1</sup> | **Description:** Choose the text for the Overlay.<br>**Default:** <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`airing`</td><td>`AIRING`</td></tr><tr><td>`returning`</td><td>`RETURNING`</td></tr><tr><td>`canceled`</td><td>`CANCELED`</td></tr><tr><td>`ended`</td><td>`ENDED`</td></tr></table>**Values:** Any String | | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number | - 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. === "Overlay Template Variables" {% - include-markdown "../overlay_text_variables.md" + include-markdown "../overlay_variables.md" %} + === "Overlay Text Template Variables" + {% - include-markdown "../overlay_variables.md" + include-markdown "../overlay_text_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: TV Shows: diff --git a/docs/defaults/overlays/streaming.md b/docs/defaults/overlays/streaming.md index 9b612f5a..84ce6199 100644 --- a/docs/defaults/overlays/streaming.md +++ b/docs/defaults/overlays/streaming.md @@ -1,6 +1,7 @@ # Streaming Services Overlay -The `streaming` Default Overlay File is used to create an overlay based on the streaming service the file is found on for each item within your library. +The `streaming` Default Overlay File is used to create an overlay based on the streaming service the file is found on +for each item within your library. ![](images/streaming.png) @@ -33,6 +34,19 @@ Supported Overlay Level: Movie, Show | hayu | `hayu` | `10` | +## Regional Variants + +Some logic is applied to allow for regional streaming service lists to be available to users depending on where they +are, as detailed below: + +| Region | Key | Description | +|:-----------------|:---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| any besides `us` | `amazon`, `disney`, `netflix` | These overlays will use regional variant lists to ensure the overlays are applied to what is available in the region specified | +| any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These overlays will not be used if the region is not `uk` as these streaming services are UK-focused | +| any besides `ca` | `crave` | These overlays will not be used if the region is not `ca` as these streaming services are Canada-focused | +| `ca` | `max`, `showtime` | These overlays will not be used if the region is `ca` as these streaming services are part of the Crave streaming service in Canada | + + ## Config The below YAML in your config.yml will create the overlays: @@ -49,11 +63,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults +work. Any value not specified will use its default value if it has one if not it's just ignored. + +??? abstract "Variable Lists (click to expand)" -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. + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. -??? info "Click to expand" + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -70,17 +90,14 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.<br>**Default:** `us`<br>**Values:** `us`,`uk`,`ca`, `da`, `de`, `es`, `fr`, `it`, `pt-br` | | `originals_only` | **Description:** Changes Streaming Service overlays to only apply to original content produced by the service.<br>**Note**: Cannot be used with `region`, and only produces overlays for `amazon`, `appletv`, `disney`, `max`, `hulu`, `netflix`, `paramount`, `peacock`<br>**Default:** `false`<br>**Values:** `true`, `false` | | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number | - 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. === "Overlay Template Variables" @@ -88,21 +105,10 @@ Note that the `template_variables:` section only needs to be used if you do want include-markdown "../overlay_variables.md" %} - ## Regional Variants - - Some logic is applied to allow for regional streaming service lists to be available to users depending on where they are, as detailed below: - - | Region | Key | Description | - |:-----------------|:---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| - | any besides `us` | `amazon`, `disney`, `netflix` | These overlays will use regional variant lists to ensure the overlays are applied to what is available in the region specified | - | any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These overlays will not be used if the region is not `uk` as these streaming services are UK-focused | - | any besides `ca` | `crave` | These overlays will not be used if the region is not `ca` as these streaming services are Canada-focused | - | `ca` | `max`, `showtime` | These overlays will not be used if the region is `ca` as these streaming services are part of the Crave streaming service in Canada | - - ### Example Template Variable Amendments +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/studio.md b/docs/defaults/overlays/studio.md index 174c767e..607e442a 100644 --- a/docs/defaults/overlays/studio.md +++ b/docs/defaults/overlays/studio.md @@ -1,6 +1,7 @@ # Studio Overlay -The `studio` Default Overlay File is used to create an overlay based on the show studio on each item within your library. +The `studio` Default Overlay File is used to create an overlay based on the show studio on each item within your +library. ![](images/studio.png) @@ -8,6 +9,12 @@ The `studio` Default Overlay File is used to create an overlay based on the show Supported library types: Movie / Show +### Bigger Style + +Below is a screenshot of the alternative White (`bigger`) style which can be set via the `style` template variable. + +![](images/studio_bigger.jpg) + ## Config The below YAML in your config.yml will create the overlays: @@ -24,11 +31,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -45,30 +58,21 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:----------------|:-------------------------------------------------------------------------------------------------| | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | | `style` | **Description:** Choose between the standard size or the **bigger** one.<br>**Values:** `bigger` | - Preview of the bigger style - - ![](images/studio_bigger.jpg) - === "Overlay Template Variables" {% include-markdown "../overlay_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/versions.md b/docs/defaults/overlays/versions.md index 055ed249..e248faa2 100644 --- a/docs/defaults/overlays/versions.md +++ b/docs/defaults/overlays/versions.md @@ -1,6 +1,7 @@ # Versions Overlay -The `versions` Default Overlay File is used to create an overlay based on if there's multiple versions on each item within your library. +The `versions` Default Overlay File is used to create an overlay based on if there's multiple versions on each item +within your library. ![](images/version.png) @@ -30,11 +31,17 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -51,10 +58,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:----------------|:--------------------------------------------------------------------------------| | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | @@ -64,13 +67,11 @@ Note that the `template_variables:` section only needs to be used if you do want {% include-markdown "../overlay_variables.md" %} - - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: Movies: diff --git a/docs/defaults/overlays/video_format.md b/docs/defaults/overlays/video_format.md index 272a988e..385ee699 100644 --- a/docs/defaults/overlays/video_format.md +++ b/docs/defaults/overlays/video_format.md @@ -1,6 +1,7 @@ # Video Format Overlay -The `video_format` Default Overlay File is used to create an overlay based on the video format available on each item within your library. +The `video_format` Default Overlay File is used to create an overlay based on the video format available on each item +within your library. ![](images/video_format.png) @@ -43,11 +44,19 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" + + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. + + * **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults. + + * **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults. ??? example "Default Template Variable Values (click to expand)" @@ -64,10 +73,6 @@ Note that the `template_variables:` section only needs to be used if you do want === "File-Specific Template Variables" - The below template variables are available specifically for this PMM Defaults file. - - Be sure to also check out the "Overlay Template Variables" tab for additional variables. - | Variable | Description & Values | |:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` | @@ -75,23 +80,25 @@ Note that the `template_variables:` section only needs to be used if you do want | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number | | `regex_<<key>>`<sup>1</sup> | **Description:** Controls the regex of the Overlay Search.<br>**Values:** Any Proper Regex | - 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. + 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` + with when calling. === "Overlay Template Variables" {% - include-markdown "../overlay_text_variables.md" + include-markdown "../overlay_variables.md" %} + === "Overlay Text Template Variables" + {% - include-markdown "../overlay_variables.md" + include-markdown "../overlay_text_variables.md" %} - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. - - + ```yaml libraries: Movies: diff --git a/docs/defaults/people.md b/docs/defaults/people.md index 418e8d01..09940e34 100644 --- a/docs/defaults/people.md +++ b/docs/defaults/people.md @@ -2,22 +2,22 @@ This Default can use the `style` template variable to easily change the posters styles. -### Black & White Style (Default) +??? tip "Black & White Style (Default) (click to expand)" -![](images/person_bw.png) + ![](images/person_bw.png) -### Rainier Style +??? tip "Rainier Style (click to expand)" -![](images/person_rainier.png) + ![](images/person_rainier.png) -### Signature Style +??? tip "Signature Style (click to expand)" -![](images/person_signature.png) + ![](images/person_signature.png) -### Diiivoy Style +??? tip "Diiivoy Style (click to expand)" -![](images/person_diiivoy.png) + ![](images/person_diiivoy.png) -### Diiivoy Color Style +??? tip "Diiivoy Color Style (click to expand)" -![](images/person_diiivoycolor.png) + ![](images/person_diiivoycolor.png) diff --git a/docs/defaults/playlist.md b/docs/defaults/playlist.md index 36b9f661..0bd89699 100644 --- a/docs/defaults/playlist.md +++ b/docs/defaults/playlist.md @@ -1,10 +1,14 @@ # Playlists -The `playlist` Default Collection File is used to create playlists based on popular Movie/TV Show universes (such as the Marvel Cinematic Universe or Star Trek). +The `playlist` Default Collection File is used to create playlists based on popular Movie/TV Show universes (such as the +Marvel Cinematic Universe or Star Trek). This Default file requires [Trakt Authentication](../config/trakt.md) -This file assumes that you have libraries named `Movies` and `TV Shows`. If you do not have these libraries or want to use alternative/additional libraries, use the `libraries` template variable which is outlined in the [Template Variables](#template-variables) table. +This file assumes that you have libraries named `Movies` and `TV Shows`. If you do not have these libraries or want to +use alternative/additional libraries, use the `libraries` template variable which is outlined in the +[Template Variables](#template-variables) table. + ![](images/playlist.png) ## Playlists @@ -32,15 +36,21 @@ playlist_files: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults +work. Any value not specified will use its default value if it has one if not it's just ignored. + +??? abstract "Variable Lists (click to expand)" -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored. + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. -**[Shared Variables](collection_variables.md) are NOT available to this default file.** + ???+ warning -??? info "Click to expand" + [Shared Collection Variables](collection_variables.md) are NOT available to this default file. - The below template variables are available specifically for this PMM Defaults file. + === "File-Specific Template Variables" | Variable | Description & Values | |:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -76,32 +86,37 @@ Note that the `template_variables:` section only needs to be used if you do want | `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's playlist.<br>**Default:** `item_sonarr_tag`<br>**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 `<<key>>` with when calling. - - ### Example Template Variable Amendments + +???+ example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more ```yaml playlist_files: - pmm: playlist template_variables: - radarr_add_missing: true + radarr_add_missing: true #(1)! ``` + 1. Adds items from the source list which are not in Plex to Radarr + ## 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.** +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. ??? example "Default Template Variable `trakt_list` (click to expand) <a class="headerlink" href="#trakt-list" title="Permanent link">¶</a>" + <div id="trakt-list" /> + ???+ tip Pass `trakt_list_<<key>>` to the file as template variables to change this value per playlist. - <div id="trakt-list" /> - ```yaml {% include-markdown "../../defaults/playlist.yml" diff --git a/docs/defaults/separator_variables.md b/docs/defaults/separator_variables.md new file mode 100644 index 00000000..2ce2ece0 --- /dev/null +++ b/docs/defaults/separator_variables.md @@ -0,0 +1,15 @@ + +| Variable | Description & Values | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the [Separator Collection](separators.md#use-separators) off.<br>**Values:** `false` to turn of the collection | +| `sep_style` | **Description:** Choose the [Separator Style](separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `amethyst`, `aqua`, `blue`, `forest`, `fuchsia`, `gold`, `gray`, `green`, `navy`, `ocean`, `olive`, `orchid`, `orig`, `pink`, `plum`, `purple`, `red`, `rust`, `salmon`, `sand`, `stb`, or `tan` | +| `sort_prefix` | **Description:** Changes the prefix of the sort title.<br>**Default:** `!`<br>**Values:** Any String | +| `sort_title` | **Description:** Changes the sort title of all collections.<br>**Default:** `<<sort_prefix>><<collection_section>>_!<<title>>`<br>**Values:** Any String | +| `placeholder_tmdb_movie` | **Description:** Add a placeholder Movie to the Separator. Only valid for Movie libraries.<br>**Values:** TMDb Movie ID | +| `placeholder_tvdb_show` | **Description:** Add a placeholder Show to the Separator. Only valid for Show libraries.<br>**Values:** TVDb Show ID | +| `placeholder_imdb_id` | **Description:** Add a placeholder Movie/Show to the Separator. Valid for Movie or Show libraries assuming the ID points to an item of the correct type.<br>**Values:** IMDb ID | +| `name_separator` | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name | +| `summary_separator` | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary | +| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number | +| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> | +| `url_poster_separator` | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image | diff --git a/docs/defaults/separators.md b/docs/defaults/separators.md index f34f014a..484b9cc3 100644 --- a/docs/defaults/separators.md +++ b/docs/defaults/separators.md @@ -47,20 +47,9 @@ Note that the `template_variables:` section only needs to be used if you do want **[Shared Variables](collection_variables.md) are NOT available to separator collections in any default file.** -| Variable | Description & Values | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the [Separator Collection](#use-separators) off.<br>**Values:** `false` to turn of the collection | -| `sep_style` | **Description:** Choose the [Separator Style](#separator-styles).<br>**Default:** `orig`<br>**Values:** `amethyst`, `aqua`, `blue`, `forest`, `fuchsia`, `gold`, `gray`, `green`, `navy`, `ocean`, `olive`, `orchid`, `orig`, `pink`, `plum`, `purple`, `red`, `rust`, `salmon`, `sand`, `stb`, or `tan` | -| `sort_prefix` | **Description:** Changes the prefix of the sort title.<br>**Default:** `!`<br>**Values:** Any String | -| `sort_title` | **Description:** Changes the sort title of all collections.<br>**Default:** `<<sort_prefix>><<collection_section>>_!<<title>>`<br>**Values:** Any String | -| `placeholder_tmdb_movie` | **Description:** Add a placeholder Movie to the Separator. Only valid for Movie libraries.<br>**Values:** TMDb Movie ID | -| `placeholder_tvdb_show` | **Description:** Add a placeholder Show to the Separator. Only valid for Show libraries.<br>**Values:** TVDb Show ID | -| `placeholder_imdb_id` | **Description:** Add a placeholder Movie/Show to the Separator. Valid for Movie or Show libraries assuming the ID points to an item of the correct type.<br>**Values:** IMDb ID | -| `name_separator` | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name | -| `summary_separator` | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary | -| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number | -| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> | -| `url_poster_separator` | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image | +{% + include-markdown "./separator_variables.md" +%} ## Use Separators diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index fde7c175..b385bd07 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -1,10 +1,12 @@ # US Content Rating Collections -The `content_rating_us` Default Collection File is used to dynamically create collections based on the content ratings available in your library. +The `content_rating_us` Default Collection File is used to dynamically create collections based on the content ratings +available in your library. -If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system. +If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to +the respective rating system. -**This file has a Movie Library [Counterpart](../movie/content_rating_us.md).** +**[This file has a Movie Library Counterpart.](../movie/content_rating_us.md)** ![](../images/moviecontent_rating_us.png) @@ -14,11 +16,11 @@ Supported Library Types: Show ## Collections Section 110 -| Collection | Key | Description | -|:---------------------------------------------------------|:---------------------------------------------|:---------------------------------------------------------------------------------| -| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | -| `<<Content Rating>> Shows`<br>**Example:** `TV-14 Shows` | `<<Content Rating>>`<br>**Example:** `TV-14` | Collection of Shows that have this Content Rating. | -| `Not Rated Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. | +| Collection | Key | Description | +|:---------------------------------------------------------|:---------------------------------------------|:-------------------------------------------------------------------------------| +| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | +| `<<Content Rating>> Shows`<br>**Example:** `TV-14 Shows` | `<<Content Rating>>`<br>**Example:** `TV-14` | Collection of Shows that have this Content Rating. | +| `Not Rated Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. | ## Config @@ -33,19 +35,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -71,18 +76,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -100,12 +105,14 @@ Note that the `template_variables:` section only needs to be used if you do want 1. Use the blue [Separator Style](../separators.md#separator-styles) 2. Do not create a "Not Rated Movies" collection 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 + 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 -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. diff --git a/docs/defaults/show/continent.md b/docs/defaults/show/continent.md index 984ab67a..f65b2eb3 100644 --- a/docs/defaults/show/continent.md +++ b/docs/defaults/show/continent.md @@ -2,7 +2,7 @@ The `continent` Default Collection File is used to dynamically create collections based on the countries within your library. The collection aims to be inclusive, with all 230 countries incorporated into seven continents. -**This file has a Movie Library [Counterpart](../movie/continent.md).** +**[This file has a Movie Library Counterpart.](../movie/continent.md).** ![](../images/continent1.png) @@ -78,37 +78,31 @@ Note that the `template_variables:` section only needs to be used if you do want {% 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: continent - template_variables: - use_other: false #(1)! - use_separator: false #(2)! - style: color #(3)! - exclude: - - Europe #(4)! - sort_by: title.asc - ``` - - 1. Do not create the "Other Continents" collection - 2. Do not create a "Continent Collections" separator - 3. Set the [Color Style](#color-style) - 4. Exclude "Europe" from the list of collections that are created + + ???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: continent + template_variables: + use_other: false #(1)! + use_separator: false #(2)! + style: color #(3)! + exclude: + - Europe #(4)! + sort_by: title.asc + ``` + + 1. Do not create the "Other Continents" collection + 2. Do not create a "Continent Collections" separator + 3. Set the [Color Style](#color-style) + 4. Exclude "Europe" from the list of collections that are created ## Default Values diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index 5357a5bf..fef51ef5 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -2,7 +2,7 @@ The `country` Default Collection File is used to dynamically create collections based on the countries available in your library. -**This file has a Movie Library [Counterpart](../movie/country.md).** +**[This file has a Movie Library Counterpart.](../movie/country.md).** ![](../images/country1.png) @@ -78,37 +78,31 @@ Note that the `template_variables:` section only needs to be used if you do want {% 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: country - template_variables: - use_other: false #(1)! - use_separator: false #(2)! - style: color #(3)! - exclude: - - France #(4)! - sort_by: title.asc - ``` - - 1. Do not create the "Other Countries" collection - 2. Do not create a "Country Collections" separator - 3. Set the [Color Style](#color-style) - 4. Exclude "France" from the list of collections that are created + + ???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + Movies: + collection_files: + - pmm: country + template_variables: + use_other: false #(1)! + use_separator: false #(2)! + style: color #(3)! + exclude: + - France #(4)! + sort_by: title.asc + ``` + + 1. Do not create the "Other Countries" collection + 2. Do not create a "Country Collections" separator + 3. Set the [Color Style](#color-style) + 4. Exclude "France" from the list of collections that are created ## Default Values diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index 517c6323..68b014f6 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -1,8 +1,9 @@ # Decade Collections -The `decade` Collection File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>" +The `decade` Collection File is used to dynamically create collections based on the decades available in your library, +sorted by critic rating to create a "best of <decade>" -**This file has a Movie Library [Counterpart](../movie/decade.md).** +**[This file has a Movie Library Counterpart.](../movie/decade.md)** ![](../images/decade.png) @@ -30,19 +31,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -54,29 +58,27 @@ Note that the `template_variables:` section only needs to be used if you do want | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Best of <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Top <<limit>> <<library_translation>>s of the <<key_name>>.`<br>**Values:** Any string. | - 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. -{% - include-markdown "../collection_variables.md" -%} === "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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -89,4 +91,4 @@ Note that the `template_variables:` section only needs to be used if you do want ``` 1. Use the purple [Separator Style](../separators.md#separator-styles) - 2. Set the sort order for "Best of 2020s" to release date descending \ No newline at end of file + 2. Set the sort order for "Best of 2020s" to release date descending diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index c1ddc276..bbc2f252 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -1,10 +1,13 @@ # Franchise Collections -The `franchise` Default Collection File is used to create collections based on popular TV Show franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box. +The `franchise` Default Collection File is used to create collections based on popular TV Show franchises, and can be +used as a replacement to the TMDb Collections that Plex creates out-of-the-box. -Unlike most Default Collection Files, Franchise works by placing collections inline with the main library items if your library allows it. For example, the "Pretty Little Liars" franchise collection will appear next to the "Pretty Little Liars" show in your library so that you have easy access to the other shows in the franchise. +Unlike most Default Collection Files, Franchise works by placing collections inline with the main library items if your +library allows it. For example, the "Pretty Little Liars" franchise collection will appear next to the "Pretty Little +Liars" show in your library so that you have easy access to the other shows in the franchise. -**This file has a Movie Library [Counterpart](../movie/franchise.md).** +**[This file has a Movie Library Counterpart.](../movie/franchise.md)** ![](../images/showfranchise.png) @@ -29,20 +32,23 @@ libraries: - pmm: franchise ``` - ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. + +Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults +work. Any value not specified will use its default value if it has one if not it's just ignored. -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. +??? abstract "Variable Lists (click to expand)" -??? info "Click to expand" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - === "Template Variables" + ???+ warning - The below template variables are available specifically for this PMM Defaults file. + [Shared Collection Variables](../collection_variables.md) are NOT available to this default file. - **[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.** + === "File-Specific Template Variables" | Variable | Description & Values | |:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -75,40 +81,38 @@ Note that the `template_variables:` section only needs to be used if you do want | `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every show found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags | | `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every show found by the builders that's in Sonarr of the specified key's collection.<br>**Default:** `item_sonarr_tag`<br>**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 `<<key>>` with when calling. - - ### 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: - TV Shows: - collection_files: - - pmm: franchise - template_variables: - append_data: - "31917": Pretty Little Liars #(1)! - append_addons: - 31917: [46958, 79863, 110531] #(2)! - sonarr_add_missing: true #(3)! - ``` - - 1. Add [TMDb Show 31917](https://www.themoviedb.org/tv/31917-pretty-little-liars) to the data dictionary - 2. Add [TMDb Shows 46958](https://www.themoviedb.org/tv/46958), [79863](https://www.themoviedb.org/tv/79863) and [110531](https://www.themoviedb.org/tv/110531) as addons of [TMDb Show 31917](https://www.themoviedb.org/tv/31917-pretty-little-liars) so that they appear in the same collection - 3. Add items missing from your library in Plex to Sonarr + 1. Each default collection has a `key` that when calling to effect a specific collection you must replace + `<<key>>` with when calling. + + ???+ example "Example Template Variable Amendments" + + The below is an example config.yml extract with some Template Variables added in to change how the file works. + + Click the :fontawesome-solid-circle-plus: icon to learn more + + ```yaml + libraries: + TV Shows: + collection_files: + - pmm: franchise + template_variables: + append_data: + "31917": Pretty Little Liars #(1)! + append_addons: + 31917: [46958, 79863, 110531] #(2)! + sonarr_add_missing: true #(3)! + ``` + + 1. Add [TMDb Show 31917](https://www.themoviedb.org/tv/31917-pretty-little-liars) to the data dictionary + 2. Add [TMDb Shows 46958](https://www.themoviedb.org/tv/46958), [79863](https://www.themoviedb.org/tv/79863) + and [110531](https://www.themoviedb.org/tv/110531) as addons of [TMDb Show + 31917](https://www.themoviedb.org/tv/31917-pretty-little-liars) so that they appear in the same collection + 3. Add items missing from your library in Plex to Sonarr ## 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.** +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. diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index 338a2324..38e61bd6 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -40,19 +40,22 @@ libraries: ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -79,18 +82,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -111,7 +114,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. diff --git a/docs/defaults/show/region.md b/docs/defaults/show/region.md index 5f8c1a85..58413868 100644 --- a/docs/defaults/show/region.md +++ b/docs/defaults/show/region.md @@ -1,8 +1,13 @@ # Region Collections -The `region` Default Collection File is used to dynamically create collections based on the countries within your library. The collection aims to be inclusive, with all 230 countries incorporated into 39 countries or collections of countries. Some care has been taken to ensure all countries are included, and the groupings won't fit well with everyone's collections. Western and Southern Europe, Oceania, and North America could be useful groupings for those libraries with more of an Asian focus, for instance. Please see the comments in the yml below where a decision point might be seen as controversial. You are welcome to edit this to fit your own audience's needs. +The `region` Default Collection File is used to dynamically create collections based on the countries within your +library. The collection aims to be inclusive, with all 230 countries incorporated into 39 countries or collections of +countries. Some care has been taken to ensure all countries are included, and the groupings won't fit well with +everyone's collections. Western and Southern Europe, Oceania, and North America could be useful groupings for those +libraries with more of an Asian focus, for instance. Please see the comments in the yml below where a decision point +might be seen as controversial. You are welcome to edit this to fit your own audience's needs. -**This file has a Movie Library [Counterpart](../movie/region.md).** +**[This file has a Movie Library Counterpart.](../movie/region.md)** ![](../images/region1.png) @@ -12,11 +17,11 @@ Supported Library Types: Show ## Collections Section 081 -| Collection | Key | Description | -|:--------------------------------------|:--------------------------------------------------------|:---------------------------------------------------------------------------------| -| `Region Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | -| `<<Region>>`<br>**Example:** `German` | `<<2 digit ISO 3166-1 code>>`<br>**Example:** `German ` | Collection of TV Shows that have this Region. | -| `Other Regions` | `other` | Collection of TV Shows that are in other uncommon Regions. | +| Collection | Key | Description | +|:--------------------------------------|:--------------------------------------------------------|:-------------------------------------------------------------------------------| +| `Region Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | +| `<<Region>>`<br>**Example:** `German` | `<<2 digit ISO 3166-1 code>>`<br>**Example:** `German ` | Collection of TV Shows that have this Region. | +| `Other Regions` | `other` | Collection of TV Shows that are in other uncommon Regions. | ## Config @@ -37,19 +42,22 @@ Below is a screenshot of the alternative Color (`color`) style which can be set ## 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. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to +make your own local copy. -Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored. +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. -??? info "Click to expand" +??? abstract "Variable Lists (click to expand)" - === "File-Specific Template Variables" + * **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. - The below template variables are available specifically for this PMM Defaults file. + * **Shared Template Variables** are additional variables shared across the PMM Defaults. - Be sure to also check out the "Shared Template Variables" tab for additional variables. + * **Shared Separator Variables** are additional variables available since this Default contains a + [Separator](../separators.md). - This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + === "File-Specific Template Variables" | Variable | Description & Values | |:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -79,18 +87,18 @@ Note that the `template_variables:` section only needs to be used if you do want 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. + === "Shared Separator Variables" - ???+ tip + {% + include-markdown "../separator_variables.md" + %} + +???+ example "Example Template Variable Amendments" - Anywhere you see this icon: - - > :fontawesome-solid-circle-plus: - - That's a tooltip, you can press them to get more information. + The below is an example config.yml extract with some Template Variables added in to change how the file works. + Click the :fontawesome-solid-circle-plus: icon to learn more + ```yaml libraries: Movies: @@ -112,7 +120,8 @@ Note that the `template_variables:` section only needs to be used if you do want ## 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.** +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. diff --git a/docs/files/builders/overview.md b/docs/files/builders/overview.md index 25e2f3ce..d77300fb 100644 --- a/docs/files/builders/overview.md +++ b/docs/files/builders/overview.md @@ -2,7 +2,6 @@ Builders use third-party services to source items to be added to the collection. Multiple builders can be used in the same collection from a variety of sources listed below. - ::cards:: cols=5 image-bg - title: Plex (Smart) diff --git a/mkdocs.yml b/mkdocs.yml index 5681c512..03b28b92 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -192,14 +192,20 @@ nav: - Award: - Separator: defaults/award/separator.md - Academy Awards (Oscars): defaults/award/oscars.md + - Berlin Film Festival Awards: defaults/award/berlinale.md - British Academy of Film Awards: defaults/award/bafta.md - Cannes Film Festival Awards: defaults/award/cannes.md + - César Awards: defaults/award/cesar.md - Critics Choice Awards: defaults/award/choice.md - Emmy Awards: defaults/award/emmy.md - Golden Globe Awards: defaults/award/golden.md - Independent Spirit Awards: defaults/award/spirit.md + - National Film Registry: defaults/award/nfr.md + - People's Choice Awards: defaults/award/pca.md + - Razzie Awards: defaults/award/razzie.md - Sundance Film Festival Awards: defaults/award/sundance.md - - Other Awards: defaults/award/other.md + - Toronto International Film Festival: defaults/award/tiff.md + - Venice Film Festival Awards: defaults/award/venice.md - Chart: - Separator: defaults/chart/separator.md - Basic Charts: defaults/chart/basic.md @@ -217,6 +223,7 @@ nav: - Franchises (Show): defaults/show/franchise.md - Universes: defaults/both/universe.md - Based On...: defaults/both/based.md + - Collectionless: defaults/both/collectionless.md - Content Rating: - US Content Ratings (Movie): defaults/movie/content_rating_us.md - US Content Ratings (Show): defaults/show/content_rating_us.md @@ -232,7 +239,7 @@ nav: - Continents (Movie): defaults/movie/continent.md - Continents (Show): defaults/show/continent.md - Media: - - Aspect Ration (Show): defaults/both/aspect.md + - Aspect Ratio: defaults/both/aspect.md - Resolutions: defaults/both/resolution.md - Audio Languages: defaults/both/audio_language.md - Subtitle Languages: defaults/both/subtitle_language.md @@ -250,8 +257,6 @@ nav: - Years: defaults/both/year.md - Decades (Movie): defaults/movie/decade.md - Decades (Show): defaults/show/decade.md - - Utility: - - Collectionless: defaults/both/collectionless.md - PLAYLIST DEFAULTS: - Playlists: defaults/playlist.md - OVERLAY DEFAULTS: diff --git a/modules/builder.py b/modules/builder.py index 47097df5..ff0d5924 100644 --- a/modules/builder.py +++ b/modules/builder.py @@ -3195,7 +3195,6 @@ class CollectionBuilder: title = f"{title[len(op):].strip()}, {op.strip()}" break new_sort_title = new_sort_title.replace("<<title>>", title) - logger.info(new_sort_title) if new_sort_title != str(self.obj.titleSort): self.obj.editSortTitle(new_sort_title) batch_display += f"\nSort Title | {new_sort_title}"