mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
[110] wiki update
This commit is contained in:
parent
b610e4aa59
commit
fdf3494227
45 changed files with 1514 additions and 707 deletions
2
VERSION
2
VERSION
|
@ -1 +1 @@
|
|||
1.17.3-develop109
|
||||
1.17.3-develop110
|
||||
|
|
|
@ -1,32 +1,10 @@
|
|||
#############################################################
|
||||
# Dynamic Country Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# Artwork Credit to Duhniel #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Movie only) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/movie/country #
|
||||
# template_variables: #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# # Turn the other collection on/off #
|
||||
# use_other: true #
|
||||
# # Sets the style of posters: color or white #
|
||||
# style: white #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by: release.desc #
|
||||
# # Sets the collection mode of the collection #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: "09" #
|
||||
# # Radarr Tag for existing items #
|
||||
# item_radarr_tag: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# Country Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# Artwork Credit to Duhniel #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/movie/country.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
@ -45,8 +23,8 @@ collections:
|
|||
dynamic_collections:
|
||||
Country:
|
||||
type: country
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
other_name: Other Countries <<library_typeU>>s
|
||||
title_format: <<key_name>>
|
||||
other_name: Other Countries
|
||||
template:
|
||||
- smart_filter
|
||||
- translation
|
||||
|
|
|
@ -1,29 +1,9 @@
|
|||
#############################################################
|
||||
# Dynamic Decade Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Movie only) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/movie/decade #
|
||||
# template_variables: #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by: critic_rating.desc #
|
||||
# # Sets the collection mode of the collection #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: 12 #
|
||||
# # Sets the number of items per collection #
|
||||
# limit: 100 #
|
||||
# # Radarr Tag for existing items #
|
||||
# item_radarr_tag: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# Decade Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/movie/decade.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
|
|
@ -1,29 +1,9 @@
|
|||
#############################################################
|
||||
# Director Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Movie only) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/movie/director #
|
||||
# template_variables: #
|
||||
# # Sets the style of posters: bw or rainier #
|
||||
# style: bw #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by: release.desc #
|
||||
# # Sets the collection mode of the collections #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: 18 #
|
||||
# # Radarr Tag for existing items #
|
||||
# item_radarr_tag: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# Director Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/movie/director.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
|
|
@ -1,29 +1,9 @@
|
|||
#############################################################
|
||||
# Producer Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Movie only) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/movie/producer #
|
||||
# template_variables: #
|
||||
# # Sets the style of posters: bw or rainier #
|
||||
# style: bw #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by: release.desc #
|
||||
# # Sets the collection mode of the collections #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: 19 #
|
||||
# # Radarr Tag for existing items #
|
||||
# item_radarr_tag: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# Producer Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/movie/producer.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
|
|
@ -1,74 +1,9 @@
|
|||
#############################################################
|
||||
# Seasonal Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Movie only) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/movie/seasonal #
|
||||
# template_variables: #
|
||||
# # Sets the collection mode of the collection #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: "00" #
|
||||
# # Sets how all collections are sorted #
|
||||
# sort_by: title.asc #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: false #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# #
|
||||
# # For each collection use the "key" to set #
|
||||
# # the options. #
|
||||
# # Available collections #
|
||||
# # KEY COLLECTION #
|
||||
# # independence Independence Day #
|
||||
# # easter Easter #
|
||||
# # valentine Valentine's Day #
|
||||
# # patrick St. Patrick's Day #
|
||||
# # thanksgiving Thanksgiving #
|
||||
# # halloween Halloween #
|
||||
# # christmas Christmas #
|
||||
# # years New Year's Day #
|
||||
# #
|
||||
# # Available options. Replace "key" with the #
|
||||
# # desired collection's key from the chart above. #
|
||||
# #
|
||||
# # Turn the collection on/off #
|
||||
# use_key: true #
|
||||
# # Set the schedule of a collection. #
|
||||
# schedule_key: #
|
||||
# #
|
||||
# # Default Schedules #
|
||||
# # KEY COLLECTION #
|
||||
# # independence range(06/23-07/11) #
|
||||
# # easter range(03/15-04/30) #
|
||||
# # valentine range(02/01-02/29) #
|
||||
# # patrick range(03/01-03/18) #
|
||||
# # thanksgiving range(11/01-11/30) #
|
||||
# # halloween range(10/01-10/31) #
|
||||
# # christmas range(12/01-12/31) #
|
||||
# # years range(12/26-01/04) #
|
||||
# #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by_key: title.asc #
|
||||
# # Set visible_library for the collection #
|
||||
# visible_library_key: #
|
||||
# # Set visible_home for the collection #
|
||||
# visible_home_key: #
|
||||
# # Set visible_shared for the collection #
|
||||
# visible_shared_key: #
|
||||
# # Adds missing from the collection to radarr #
|
||||
# radarr_add_missing_key: #
|
||||
# # Radarr Folder to add to #
|
||||
# radarr_folder_key: #
|
||||
# # Radarr Tag for added missing #
|
||||
# radarr_tag_key: #
|
||||
# # Radarr Tag for existing items #
|
||||
# item_radarr_tag_key: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# Seasonal Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/movie/seasonal.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
@ -83,12 +18,18 @@ templates:
|
|||
sort_by: title.asc
|
||||
sort_by_<<key>>: <<sort_by>>
|
||||
schedule_<<key>>: <<schedule>>
|
||||
limit_<<key>>: <<limit>>
|
||||
optional:
|
||||
- schedule
|
||||
- tmdb_collection
|
||||
- tmdb_movie
|
||||
- limit
|
||||
smart_label:
|
||||
sort_by: <<sort_by_<<key>>>>
|
||||
limit: <<limit_<<key>>>>
|
||||
all:
|
||||
label: <<smart_label>>
|
||||
schedule: <<schedule_<<key>>>>
|
||||
smart_label: <<sort_by_<<key>>>>
|
||||
delete_not_scheduled: true
|
||||
tmdb_collection: <<tmdb_collection>>
|
||||
tmdb_movie: <<tmdb_movie>>
|
||||
|
@ -104,18 +45,18 @@ dynamic_collections:
|
|||
Seasonal:
|
||||
type: custom
|
||||
data:
|
||||
years: New Year's Day
|
||||
valentine: Valentine's Day
|
||||
patrick: St. Patrick's Day
|
||||
easter: Easter
|
||||
mother: Mother's Day
|
||||
memorial: Memorial Day
|
||||
father: Father's Day
|
||||
independence: Independence Day
|
||||
labor: Labor Day
|
||||
halloween: Halloween
|
||||
thanksgiving: Thanksgiving
|
||||
christmas: Christmas
|
||||
years: 🎊 New Year's Day
|
||||
valentine: 💘 Valentine's Day
|
||||
patrick: ☘ St. Patrick's Day
|
||||
easter: 🐰 Easter
|
||||
mother: 🤱 Mother's Day
|
||||
memorial: 🪖 Memorial Day
|
||||
father: 👨 Father's Day
|
||||
independence: 🎆 Independence Day
|
||||
labor: ⚒ Labor Day
|
||||
halloween: 🎃 Halloween
|
||||
thanksgiving: 🦃 Thanksgiving
|
||||
christmas: 🎅 Christmas
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
template:
|
||||
- holiday
|
||||
|
@ -184,4 +125,6 @@ dynamic_collections:
|
|||
default: seasonal/<<key>>
|
||||
translation_key:
|
||||
default: season
|
||||
use_separator:
|
||||
default: false
|
||||
|
||||
|
|
|
@ -1,29 +1,9 @@
|
|||
#############################################################
|
||||
# Writer Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Movie only) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/writer #
|
||||
# template_variables: #
|
||||
# # Sets the style of posters: bw or rainier #
|
||||
# style: bw #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by: release.desc #
|
||||
# # Sets the collection mode of the collections #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: 20 #
|
||||
# # Radarr Tag for existing items #
|
||||
# item_radarr_tag: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# Writer Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/movie/writer.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
|
|
@ -1,32 +1,10 @@
|
|||
#############################################################
|
||||
# Dynamic Country Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# Artwork Credit to Duhniel #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Show only) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/show/country #
|
||||
# template_variables: #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# # Turn the other collection on/off #
|
||||
# use_other: true #
|
||||
# # Sets the style of posters: color or white #
|
||||
# style: white #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by: release.desc #
|
||||
# # Sets the collection mode of the collection #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: "09" #
|
||||
# # Sonarr Tag for existing items #
|
||||
# item_sonarr_tag: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# Country Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# Artwork Credit to Duhniel #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/show/country.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
@ -45,7 +23,7 @@ collections:
|
|||
dynamic_collections:
|
||||
Country:
|
||||
type: origin_country
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
title_format: <<key_name>>
|
||||
other_name: Other Countries
|
||||
template:
|
||||
- filter
|
||||
|
|
|
@ -1,29 +1,9 @@
|
|||
#############################################################
|
||||
# Dynamic Decade Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Show only) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/show/decade #
|
||||
# template_variables: #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by: critic_rating.desc #
|
||||
# # Sets the collection mode of the collection #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: 12 #
|
||||
# # Sets the number of items per collection #
|
||||
# limit: 100 #
|
||||
# # Sonarr Tag for existing items #
|
||||
# item_sonarr_tag: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# Decade Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/show/decade.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
|
|
@ -1,29 +1,9 @@
|
|||
#############################################################
|
||||
# Dynamic Network Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Show only) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/show/network #
|
||||
# template_variables: #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# # Turn the other collection on/off #
|
||||
# use_other: true #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by: release.desc #
|
||||
# # Sets the collection mode of the collection #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: "04" #
|
||||
# # Sonarr Tag for existing items #
|
||||
# item_sonarr_tag: #
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# Network Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/show/network.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
@ -45,9 +25,7 @@ dynamic_collections:
|
|||
title_format: <<key_name>>
|
||||
template:
|
||||
- smart_filter
|
||||
- shared
|
||||
other_template:
|
||||
- smart_filter
|
||||
- translation
|
||||
- shared
|
||||
template_variables:
|
||||
search_term:
|
||||
|
|
|
@ -82,7 +82,14 @@ templates:
|
|||
default:
|
||||
sort_by: release.desc
|
||||
sort_by_<<key>>: <<sort_by>>
|
||||
smart_label: <<sort_by_<<key>>>>
|
||||
limit_<<key>>: <<limit>>
|
||||
optional:
|
||||
- limit
|
||||
smart_label:
|
||||
sort_by: <<sort_by_<<key>>>>
|
||||
limit: <<limit_<<key>>>>
|
||||
all:
|
||||
label: <<smart_label>>
|
||||
sync_mode: sync
|
||||
plex_all: true
|
||||
filters:
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
content_rating_other_name: Changed `Other Ratings` to `Not Rated <<library_translationU>>s`
|
||||
content_rating_other_summary: Changed `<<library_translationU>>s with other uncommon Ratings.` to `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`
|
||||
resolution_other_name: Changed `Other Resolution` to `Other Resolution <<library_translationU>>s`
|
||||
country_other_name: Changed `Other Countries` to `Other Countries <<library_translationU>>s`
|
||||
country_name: Changed `<<key_name>> <<library_translationU>>s` to `<<key_name>>`
|
||||
Added content_rating_cs_name and content_rating_cs_summary
|
||||
|
||||
1.18.0.1 -> 1.18.0.2
|
||||
|
|
|
@ -215,10 +215,10 @@ translations:
|
|||
content_rating_other_summary: <<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.
|
||||
|
||||
# example key_name: United States
|
||||
country_name: <<key_name>> <<library_translationU>>s
|
||||
country_name: <<key_name>>
|
||||
country_summary: <<library_translationU>>s filmed in <<key_name>>.
|
||||
|
||||
country_other_name: Other Countries <<library_translationU>>s
|
||||
country_other_name: Other Countries
|
||||
country_other_summary: <<library_translationU>>s filmed in other uncommon Countries.
|
||||
|
||||
# example key_name: 2010s
|
||||
|
|
|
@ -206,7 +206,7 @@ html_theme_options = {
|
|||
("_menu", "Movie Collections", [
|
||||
("Actor Collections", "defaults/both/actor"),
|
||||
("Audio Language Collections", "defaults/both/audio_language"),
|
||||
("Content Ratings (US) Collections", "defaults/both/content_rating_us"),
|
||||
("Content Ratings (US) Collections", "defaults/movie/content_rating_us"),
|
||||
("Content Ratings (UK) Collections", "defaults/both/content_rating_uk"),
|
||||
("Country Collections", "defaults/movie/country"),
|
||||
("Decade Collections", "defaults/movie/decade"),
|
||||
|
@ -227,7 +227,7 @@ html_theme_options = {
|
|||
("_menu", "Show Collections", [
|
||||
("Actor Collections", "defaults/both/actor"),
|
||||
("Audio Language Collections", "defaults/both/audio_language"),
|
||||
("Content Ratings (US) Collections", "defaults/both/content_rating_us"),
|
||||
("Content Ratings (US) Collections", "defaults/show/content_rating_us"),
|
||||
("Content Ratings (UK) Collections", "defaults/both/content_rating_uk"),
|
||||
("Country Collections", "defaults/show/country"),
|
||||
("Decade Collections", "defaults/show/decade"),
|
||||
|
|
|
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| `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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **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](../../metadata/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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><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:** Any list of Years |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| `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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **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](../../metadata/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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><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:** Any list of Years |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| `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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **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](../../metadata/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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><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:** Any list of Years |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| `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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **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](../../metadata/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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><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:** Any list of Years |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -41,7 +41,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| `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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **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](../../metadata/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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><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:** Any list of Years |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| `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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **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](../../metadata/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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><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:** Any list of Years |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| `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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **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](../../metadata/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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><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:** Any list of Years |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| `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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>` | **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](../../metadata/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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><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:** Any list of Years |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -44,12 +44,14 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| Variable | Description & Values |
|
||||
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `style ` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>bw</code></td><td>Black & White Theme</td></tr><tr><td><code>rainier</code></td><td>Rainier Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<hr><strong>Default:</strong> 5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<hr><strong>Default:</strong> 25<hr><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||
| `exclude` | **Description:** Exclude these Actors from creating a Dynamic Collection.<br>**Values:** List of Actor Names. |
|
||||
| `exclude` | **Description:** Exclude these Actors from creating a Dynamic Collection.<br>**Values:** List of Actor Names |
|
||||
| `actor_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `actor_summary` | **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. |
|
||||
|
||||
|
|
|
@ -39,12 +39,14 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| Variable | Description & Values |
|
||||
|:-------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include)<br>**Values:** Any list of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.<br>**Values:** Any list of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include)<br>**Values:** Any list of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `audio_language_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Audio`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `audio_language_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Other Audio`<br>**Values:** Any string. |
|
||||
| `audio_language_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in the <<key_name>> Language.`<br>**Values:** Any string. |
|
||||
|
|
|
@ -40,21 +40,23 @@ Note that the `templates_variables:` section only needs to be used if you do wan
|
|||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** Any Content Rating found in your library |
|
||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons list](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons list](#default-addons).<br>**Values:** Any Content Rating found in your library |
|
||||
| `content_rating_cs_name` | **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. |
|
||||
| `content_rating_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Not Rated <<library_translationU>>s`<br>**Values:** Any string. |
|
||||
| `content_rating_cs_summary` | **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. |
|
||||
| `content_rating_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`<br>**Values:** Any string. |
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||
| `content_rating_cs_name` | **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. |
|
||||
| `content_rating_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Not Rated <<library_translationU>>s`<br>**Values:** Any string. |
|
||||
| `content_rating_cs_summary` | **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. |
|
||||
| `content_rating_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -38,21 +38,23 @@ Note that the `templates_variables:` section only needs to be used if you do wan
|
|||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** Any Content Rating found in your library |
|
||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons list](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons list](#default-addons).<br>**Values:** Any Content Rating found in your library |
|
||||
| `content_rating_name` | **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. |
|
||||
| `content_rating_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Not Rated <<library_translationU>>s`<br>**Values:** Any string. |
|
||||
| `content_rating_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `content_rating_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`<br>**Values:** Any string. |
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||
| `content_rating_name` | **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. |
|
||||
| `content_rating_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Not Rated <<library_translationU>>s`<br>**Values:** Any string. |
|
||||
| `content_rating_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `content_rating_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -37,17 +37,19 @@ Note that the `templates_variables:` section only needs to be used if you do wan
|
|||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.<br>**Values:** List of Genres found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons list](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Genres found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons list](#default-addons).<br>**Values:** Any Genres found in your library |
|
||||
| `genre_name` | **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. |
|
||||
| `genre_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the genre <<key_name>>.`<br>**Values:** Any string. |
|
||||
| Variable | Description & Values |
|
||||
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.<br>**Values:** List of Genres found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Genres found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Genres found in your library |
|
||||
| `genre_name` | **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. |
|
||||
| `genre_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the genre <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -37,17 +37,19 @@ Note that the `templates_variables:` section only needs to be used if you do wan
|
|||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.<br>**Values:** List of Resolutions found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons list](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Resolution found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons list](#default-addons).<br>**Values:** Any Resolution found in your library |
|
||||
| `resolution_name` | **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. |
|
||||
| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.<br>**Values:** List of Resolutions found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Resolutions found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Resolutions found in your library |
|
||||
| `resolution_name` | **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. |
|
||||
| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -40,21 +40,23 @@ Note that the `templates_variables:` section only needs to be used if you do wan
|
|||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** Any Resolution found in your library |
|
||||
| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.<br>**Values:** List of Resolutions found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons list](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Resolution found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** Any Resolution found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons list](#default-addons).<br>**Values:** Any Resolution found in your library |
|
||||
| `resolution_name` | **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. |
|
||||
| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `resolution_other_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Other Resolution <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `resolution_other_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have other uncommon resolutions.`<br>**Values:** Any string. |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** Any Resolutions found in your library |
|
||||
| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.<br>**Values:** List of Resolutions found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Resolutions found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Resolutions found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Resolutions found in your library |
|
||||
| `resolution_name` | **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. |
|
||||
| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `resolution_other_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Other Resolution <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `resolution_other_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have other uncommon resolutions.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -47,15 +47,17 @@ Note that the `templates_variables:` section only needs to be used if you do wan
|
|||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.<br>**Values:** List of Streaming Services found in your library |
|
||||
| `streaming_name` | **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. |
|
||||
| `streaming_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s streaming on <<key_name>>.`<br>**Values:** Any string. |
|
||||
| Variable | Description & Values |
|
||||
|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.<br>**Values:** List of Streaming Service Keys |
|
||||
| `streaming_name` | **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. |
|
||||
| `streaming_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s streaming on <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -37,19 +37,21 @@ Note that the `templates_variables:` section only needs to be used if you do wan
|
|||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** Any Studio found in your library |
|
||||
| `exclude` | **Description:** Exclude these Studios from creating a Dynamic Collection.<br>**Values:** List of Studios found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons list](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Studio found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** Any Studio found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons list](#default-addons).<br>**Values:** Any Studio found in your library |
|
||||
| `resolution_name` | **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. |
|
||||
| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Studios found in your library |
|
||||
| `exclude` | **Description:** Exclude these Studios from creating a Dynamic Collection.<br>**Values:** List of Studios found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Studios found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Studios found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Studios found in your library |
|
||||
| `resolution_name` | **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. |
|
||||
| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -39,12 +39,14 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| Variable | Description & Values |
|
||||
|:----------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include)<br>**Values:** Any list of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `exclude` | **Description:** Exclude these Subtitle Languages from creating a Dynamic Collection.<br>**Values:** Any list of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include)<br>**Values:** Any list of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `exclude` | **Description:** Exclude these Subtitle Languages from creating a Dynamic Collection.<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
|
||||
| `subtitle_language_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Subtitles`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `subtitle_language_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Other Subtitles`<br>**Values:** Any string. |
|
||||
| `subtitle_language_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s with <<key_name>> Subtitles.`<br>**Values:** Any string. |
|
||||
|
|
|
@ -38,11 +38,13 @@ All [Shared Variables](../variables) are available as well as the additional Var
|
|||
| Variable | Description & Values |
|
||||
|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `10`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><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:** Any list of Years |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -53,7 +53,7 @@ libraries:
|
|||
metadata_path:
|
||||
- pmm: tmdb
|
||||
template_variables:
|
||||
use_trending false
|
||||
use_trending: false
|
||||
limit_popular: 20
|
||||
visible_library_popular: true
|
||||
visible_home_popular: true
|
||||
|
|
|
@ -4,17 +4,17 @@ The `content_rating_us` Default Metadata File is used to dynamically create coll
|
|||
|
||||
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 works with Movie and TV Libraries.**
|
||||
**This file works with Movie Libraries, but has a TV Library [Counterpart](../show/content_rating_us).**
|
||||
|
||||
![](../images/moviecontent_rating_us.png)
|
||||
|
||||
## Collections Section 14
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:--------------------------------------------------------------|:-----------------------------------------:|:--------------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | Separator Collection 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 |
|
||||
|:-------------------------------------------------------|:----------------------------------------:|:--------------------------------------------------------------------------------|
|
||||
| `Country Collections` | `separator` | Separator Collection 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
|
||||
|
||||
|
@ -25,9 +25,6 @@ libraries:
|
|||
Movies:
|
||||
metadata_path:
|
||||
- pmm: content_rating_us
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: content_rating_us
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
@ -38,21 +35,23 @@ Note that the `templates_variables:` section only needs to be used if you do wan
|
|||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** Any Content Rating found in your library |
|
||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons list](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons list](#default-addons).<br>**Values:** Any Content Rating found in your library |
|
||||
| `content_rating_name` | **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. |
|
||||
| `content_rating_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Not Rated <<library_translationU>>s`<br>**Values:** Any string. |
|
||||
| `content_rating_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `content_rating_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`<br>**Values:** Any string. |
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of of Content Ratings found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||
| `content_rating_name` | **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. |
|
||||
| `content_rating_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Not Rated <<library_translationU>>s`<br>**Values:** Any string. |
|
||||
| `content_rating_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `content_rating_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
@ -73,14 +72,6 @@ libraries:
|
|||
|
||||
## Default `include`
|
||||
|
||||
<table class="clearTable">
|
||||
<tr>
|
||||
<th>Movies</th>
|
||||
<th>TV SHows</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml
|
||||
include:
|
||||
- G
|
||||
|
@ -90,32 +81,8 @@ include:
|
|||
- NC-17
|
||||
```
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
```yaml
|
||||
include:
|
||||
- TV-G
|
||||
- TV-Y
|
||||
- TV-PG
|
||||
- TV-14
|
||||
- TV-MA
|
||||
```
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Default `addons`
|
||||
|
||||
<table class="clearTable">
|
||||
<tr>
|
||||
<th>Movies</th>
|
||||
<th>TV SHows</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml
|
||||
addons:
|
||||
G:
|
||||
|
@ -178,65 +145,3 @@ addons:
|
|||
- R18
|
||||
- X
|
||||
```
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
```yaml
|
||||
addons:
|
||||
TV-G:
|
||||
- gb/U
|
||||
- gb/0+
|
||||
- U
|
||||
- G
|
||||
- 1
|
||||
- 2
|
||||
- 3
|
||||
- 4
|
||||
- 5
|
||||
- 6
|
||||
- "01"
|
||||
- "02"
|
||||
- "03"
|
||||
- "04"
|
||||
- "05"
|
||||
- "06"
|
||||
TV-Y:
|
||||
- TV-Y7
|
||||
- TV-Y7-FV
|
||||
- 7
|
||||
- 8
|
||||
- 9
|
||||
- "07"
|
||||
- "08"
|
||||
- "09"
|
||||
TV-PG:
|
||||
- gb/PG
|
||||
- gb/9+
|
||||
- 10
|
||||
- 11
|
||||
- 12
|
||||
- 13
|
||||
TV-14:
|
||||
- gb/12A
|
||||
- 12+
|
||||
- PG-13
|
||||
- TV-13
|
||||
- gb/14+
|
||||
- gb/15
|
||||
- 14
|
||||
- 15
|
||||
- 16
|
||||
- 17
|
||||
TV-MA:
|
||||
- 18
|
||||
- gb/18
|
||||
- MA-17
|
||||
- NC-17
|
||||
- R
|
||||
- TVMA
|
||||
```
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
|
@ -1,39 +1,74 @@
|
|||
# Country Default Metadata File
|
||||
# Country Collections
|
||||
|
||||
The `country` Metadata File is used to dynamically create collections based on the countries available in your library.
|
||||
The `country` Default Metadata File is used to dynamically create collections based on the countries available in your library.
|
||||
|
||||
Example Collections Created:
|
||||
**This file works with Movie Libraries, but has a TV Library [Counterpart](../show/content_rating_us).**
|
||||
|
||||
![](../images/country1.png)
|
||||
|
||||
## Collections Section 09
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:----------------------------------------|:---------------------------------------:|:-----------------------------------------------------------|
|
||||
| `Country Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `<<Country>>`<br>**Example:** `Germany` | `<<Country>>`<br>**Example:** `Germany` | Collection of Movies that have this Country. |
|
||||
| `Other Countries` | `other` | Collection of Movies that are in other uncommon Countries. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: country
|
||||
```
|
||||
|
||||
## Color Style
|
||||
Below is a screenshot of the alternative `color` style which can be set via template variables
|
||||
|
||||
Below is a screenshot of the alternative Color (`color`) style which can be set via the `style` template variable.
|
||||
|
||||
![](../images/country2.png)
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
|
||||
##############################################################################
|
||||
|
||||
| KEY |
|
||||
|:--------------------------------------------------------------------------:|
|
||||
| Network Collections |
|
||||
| Created by Yozora, Bullmoose20, & Sohjiro |
|
||||
| EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL |
|
||||
| https://metamanager.wiki/en/latest/defaults/movie/director.html |
|
||||
||
|
||||
|
||||
##############################################################################
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `addons` | **Description:** Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
| Variable | Description & Values |
|
||||
|:------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `style ` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Countries found in your library |
|
||||
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of Countries found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Countries found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Countries found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Countries found in your library |
|
||||
| `country_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `country_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Other Countries`<br>**Values:** Any string. |
|
||||
| `country_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `country_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s filmed in other uncommon Countries.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
@ -43,12 +78,254 @@ libraries:
|
|||
metadata_path:
|
||||
- pmm: country
|
||||
template_variables:
|
||||
exclude:
|
||||
- fr
|
||||
sort_by: title.asc
|
||||
collection_section: 8
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
||||
exclude:
|
||||
- France
|
||||
sort_by: title.asc
|
||||
```
|
||||
|
||||
## Default `include`
|
||||
|
||||
```yaml
|
||||
include:
|
||||
# - Afghanistan # af
|
||||
# - Åland Islands # ax
|
||||
# - Albania # al
|
||||
# - Algeria # dz
|
||||
# - Andorra # ad
|
||||
# - Angola # ao
|
||||
# - Anguilla # ai
|
||||
# - Antarctica # aq
|
||||
# - Antigua # ag
|
||||
- Argentina # ar
|
||||
# - Armenia # am
|
||||
# - Aruba # aw
|
||||
- Australia # au
|
||||
- Austria # at
|
||||
# - Azerbaijan # az
|
||||
- Bahamas # bs
|
||||
# - Bahrain # bh
|
||||
# - Bangladesh # bd
|
||||
# - Barbados # bb
|
||||
# - Belarus # by
|
||||
- Belgium # be
|
||||
# - Belize # bz
|
||||
# - Benin # bj
|
||||
# - Bermuda # bm
|
||||
# - Bhutan # bt
|
||||
# - Bolivia # bo
|
||||
# - Bonaire # bq
|
||||
# - Bosnia and Herzegovina # ba
|
||||
# - Botswana # bw
|
||||
# - Bouvet Island # bv
|
||||
- Brazil # br
|
||||
# - Brunei # bn
|
||||
- Bulgaria # bg
|
||||
# - Burkina Faso # bf
|
||||
# - Burundi # bi
|
||||
# - Cabo Verde # cv
|
||||
# - Cambodia # kh
|
||||
# - Cameroon # cm
|
||||
- Canada # ca
|
||||
# - Cayman Islands # ky
|
||||
# - Central African Republic # cf
|
||||
# - Chad # td
|
||||
- Chile # cl
|
||||
- China # cn
|
||||
# - Christmas Island # cx
|
||||
# - Cocos (Keeling) Islands # cc
|
||||
# - Colombia # co
|
||||
# - Comoros # km
|
||||
# - Congo # cg
|
||||
# - Cook Islands # ck
|
||||
- Costa Rica # cr
|
||||
# - Côte d'Ivoire # ci
|
||||
- Croatia # hr
|
||||
# - Cuba # cu
|
||||
# - Curaçao # cw
|
||||
# - Cyprus # cy
|
||||
- Czech Republic # cz
|
||||
- Denmark # dk
|
||||
# - Djibouti # dj
|
||||
# - Dominica # dm
|
||||
- Dominican Republic # do
|
||||
# - Ecuador # ec
|
||||
- Egypt # eg
|
||||
# - El Salvador # sv
|
||||
# - Equatorial Guinea # gq
|
||||
# - Eritrea # er
|
||||
- Estonia # ee
|
||||
# - Eswatini # sz
|
||||
# - Ethiopia # et
|
||||
# - Falkland Islands # fk
|
||||
# - Faroe Islands # fo
|
||||
# - Fiji # fj
|
||||
- Finland # fi
|
||||
- France # fr
|
||||
# - French Guiana # gf
|
||||
# - French Polynesia # pf
|
||||
# - Gabon # ga
|
||||
# - Gambia # gm
|
||||
# - Georgia # ge
|
||||
- Germany # de
|
||||
# - Ghana # gh
|
||||
# - Gibraltar # gi
|
||||
- Greece # gr
|
||||
# - Greenland # gl
|
||||
# - Grenada # gd
|
||||
# - Guadeloupe # gp
|
||||
# - Guam # gu
|
||||
# - Guatemala # gt
|
||||
# - Guernsey # gg
|
||||
# - Guinea # gn
|
||||
# - Guinea-Bissau # gw
|
||||
# - Guyana # gy
|
||||
# - Haiti # ht
|
||||
# - Holy See # va
|
||||
# - Honduras # hn
|
||||
- Hong Kong # hk
|
||||
- Hungary # hu
|
||||
- Iceland # is
|
||||
- India # in
|
||||
- Indonesia # id
|
||||
- Iran # ir
|
||||
# - Iraq # iq
|
||||
- Ireland # ie
|
||||
# - Isle of Man # im
|
||||
- Israel # il
|
||||
- Italy # it
|
||||
# - Jamaica # jm
|
||||
- Japan # jp
|
||||
# - Jersey # je
|
||||
# - Jordan # jo
|
||||
# - Kazakhstan # kz
|
||||
# - Kenya # ke
|
||||
# - Kiribati # ki
|
||||
- Korea # kr
|
||||
# - Kuwait # kw
|
||||
# - Kyrgyzstan # kg
|
||||
# - Lao # la
|
||||
- Latvia # lv
|
||||
# - Lebanon # lb
|
||||
# - Lesotho # ls
|
||||
# - Liberia # lr
|
||||
# - Libya # ly
|
||||
# - Liechtenstein # li
|
||||
# - Lithuania # lt
|
||||
- Luxembourg # lu
|
||||
# - Macao # mo
|
||||
# - Madagascar # mg
|
||||
# - Malawi # mw
|
||||
- Malaysia # my
|
||||
# - Maldives # mv
|
||||
# - Mali # ml
|
||||
# - Malta # mt
|
||||
# - Marshall Islands # mh
|
||||
# - Martinique # mq
|
||||
# - Mauritania # mr
|
||||
# - Mauritius # mu
|
||||
# - Mayotte # yt
|
||||
- Mexico # mx
|
||||
# - Micronesia # fm
|
||||
# - Moldova # md
|
||||
# - Monaco # mc
|
||||
# - Mongolia # mn
|
||||
# - Montenegro # me
|
||||
# - Montserrat # ms
|
||||
- Morocco # ma
|
||||
# - Mozambique # mz
|
||||
# - Myanmar # mm
|
||||
# - Namibia # na
|
||||
# - Nauru # nr
|
||||
# - Nepal # np
|
||||
- Netherlands # nl
|
||||
# - New Caledonia # nc
|
||||
- New Zealand # nz
|
||||
# - Nicaragua # ni
|
||||
# - Niger # ne
|
||||
# - Nigeria # ng
|
||||
# - Niue # nu
|
||||
# - Norfolk Island # nf
|
||||
# - Macedonia # mk
|
||||
- Norway # no
|
||||
# - Oman # om
|
||||
- Pakistan # pk
|
||||
# - Palau # pw
|
||||
# - Palestine # ps
|
||||
- Panama # pa
|
||||
# - New Guinea # pg
|
||||
# - Paraguay # py
|
||||
- Peru # pe
|
||||
- Philippines # ph
|
||||
# - Pitcairn # pn
|
||||
- Poland # pl
|
||||
- Portugal # pt
|
||||
# - Puerto Rico # pr
|
||||
- Qatar # qa
|
||||
# - Réunion # re
|
||||
- Romania # ro
|
||||
- Russia # ru
|
||||
# - Rwanda # rw
|
||||
# - Saint Barthélemy # bl
|
||||
# - Saint Lucia # lc
|
||||
# - Samoa # ws
|
||||
# - San Marino # sm
|
||||
# - Sao Tome and Principe # st
|
||||
- Saudi Arabia # sa
|
||||
# - Senegal # sn
|
||||
- Serbia # rs
|
||||
# - Seychelles # sc
|
||||
# - Sierra Leone # sl
|
||||
- Singapore # sg
|
||||
# - Slovakia # sk
|
||||
# - Slovenia # si
|
||||
# - Solomon Islands # sb
|
||||
# - Somalia # so
|
||||
- South Africa # za
|
||||
# - South Sudan # ss
|
||||
- Spain # es
|
||||
- Sri Lanka # lk
|
||||
# - Sudan # sd
|
||||
# - Suriname # sr
|
||||
- Sweden # se
|
||||
- Switzerland # ch
|
||||
# - Syria # sy
|
||||
# - Taiwan # tw
|
||||
# - Tajikistan # tj
|
||||
# - Tanzania # tz
|
||||
- Thailand # th
|
||||
# - Timor-Leste # tl
|
||||
# - Togo # tg
|
||||
# - Tokelau # tk
|
||||
# - Tonga # to
|
||||
# - Trinidad and Tobago # tt
|
||||
# - Tunisia # tn
|
||||
- Turkey # tr
|
||||
# - Turkmenistan # tm
|
||||
# - Turks and Caicos # tc
|
||||
# - Tuvalu # tv
|
||||
# - Uganda # ug
|
||||
- Ukraine # ua
|
||||
- United Arab Emirates # ae
|
||||
- United Kingdom # gb
|
||||
- United States of America # us
|
||||
# - Uruguay # uy
|
||||
# - Uzbekistan # uz
|
||||
# - Vanuatu # vu
|
||||
# - Venezuela # ve
|
||||
- Vietnam # vn
|
||||
# - Yemen # ye
|
||||
# - Zambia # zm
|
||||
# - Zimbabwe # zw
|
||||
```
|
||||
|
||||
## Default `addons`
|
||||
|
||||
```yaml
|
||||
addons:
|
||||
Korea:
|
||||
- Republic of Korea
|
||||
- South Korea
|
||||
```
|
||||
|
|
|
@ -1,12 +1,22 @@
|
|||
# Decade Default Metadata File
|
||||
# Decade Collections
|
||||
|
||||
The `decade` Metadata 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 Metadata 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>"
|
||||
|
||||
Example Collections Created:
|
||||
**This file works with Movie Libraries, but has a TV Library [Counterpart](../show/decade).**
|
||||
|
||||
![](../images/decade.png)
|
||||
|
||||
## Collections Section 12
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:-----------------------------------------------------|:---------------------------------:|:-----------------------------------------------------------|
|
||||
| `Decade Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `Best of <<Decade>>`<br>**Example:** `Best of 2020s` | `<<Year>>`<br>**Example:** `2020` | Collection of Movies released in this Decade. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
@ -14,31 +24,36 @@ libraries:
|
|||
- pmm: decade
|
||||
```
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| Variable | Description & Values |
|
||||
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `critic_rating.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.<br>**Values:** List of Decades found in your library |
|
||||
| `decade_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Best of <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `decade_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Top <<limit>> <<library_translation>>s of the <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: decade
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 18
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
sort_by: title.asc
|
||||
```
|
|
@ -1,12 +1,28 @@
|
|||
# Director Default Metadata File
|
||||
# Director Collections
|
||||
|
||||
The `director` Metadata File is used to dynamically create collections based on the most popular directors in your library.
|
||||
The `director` Default Metadata File is used to dynamically create collections based on the most popular directors in your library.
|
||||
|
||||
Example Collections Created:
|
||||
**This file only works with Movie Libraries.**
|
||||
|
||||
![](../images/director1.png)
|
||||
|
||||
The below YAML in your config.yml will create the director collections:
|
||||
## Collections Section 18
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:---------------------------------------------------|:--------------------------------------------------:|:-----------------------------------------------------------|
|
||||
| `Directors Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `<<director_name>>`<br>**Example:** `Frank Welker` | `<<director_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by the Director. |
|
||||
|
||||
#### Rainier Style
|
||||
|
||||
Below is a screenshot of the alternative Rainier (`rainier`) style which can be set via the `style` template variable.
|
||||
|
||||
![](../images/director2.png)
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
@ -14,26 +30,27 @@ libraries:
|
|||
- pmm: director
|
||||
```
|
||||
|
||||
## Rainier Style
|
||||
Below is a screenshot of the alternative `Rainier` style which can be set via template variables
|
||||
|
||||
![](../images/director2.png)
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the director file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style ` | **Description:** Controls the visual theme of the collections created<br>**Values:**`bw` - Black and white theme or</br>`rainier` - Rainier theme |
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `style ` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>bw</code></td><td>Black & White Theme</td></tr><tr><td><code>rainier</code></td><td>Rainier Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<hr><strong>Default:</strong> 5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<hr><strong>Default:</strong> 25<hr><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||
| `exclude` | **Description:** Exclude these Directors from creating a Dynamic Collection.<br>**Values:** List of Director Names |
|
||||
| `director_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> (Director)`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `director_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s directed by <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
@ -43,13 +60,11 @@ libraries:
|
|||
metadata_path:
|
||||
- pmm: director
|
||||
template_variables:
|
||||
style: rainier
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
data:
|
||||
depth: 10
|
||||
limit: 20
|
||||
style: rainier
|
||||
sort_by: title.asc
|
||||
collection_section: 12
|
||||
collection_mode: show_items
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
|
@ -1,12 +1,28 @@
|
|||
# Producer Default Metadata File
|
||||
# Producer Collections
|
||||
|
||||
The `producer` Metadata File is used to dynamically create collections based on the most popular producers in your library.
|
||||
The `producer` Default Metadata File is used to dynamically create collections based on the most popular producers in your library.
|
||||
|
||||
Example Collections Created:
|
||||
**This file only works with Movie Libraries.**
|
||||
|
||||
![](../images/producer1.png)
|
||||
|
||||
The below YAML in your config.yml will create the producer collections:
|
||||
## Collections Section 19
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:---------------------------------------------------|:--------------------------------------------------:|:-----------------------------------------------------------|
|
||||
| `Producer Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `<<producer_name>>`<br>**Example:** `Frank Welker` | `<<producer_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by th Producer. |
|
||||
|
||||
#### Rainier Style
|
||||
|
||||
Below is a screenshot of the alternative Rainier (`rainier`) style which can be set via the `style` template variable.
|
||||
|
||||
![](../images/producer2.png)
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
@ -14,26 +30,27 @@ libraries:
|
|||
- pmm: producer
|
||||
```
|
||||
|
||||
## Rainier Style
|
||||
Below is a screenshot of the alternative `Rainier` style which can be set via template variables
|
||||
|
||||
![](../images/producer2.png)
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the producer file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style ` | **Description:** Controls the visual theme of the collections created<br>**Values:**`bw` - Black and white theme or</br>`rainier` - Rainier theme |
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `style ` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>bw</code></td><td>Black & White Theme</td></tr><tr><td><code>rainier</code></td><td>Rainier Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<hr><strong>Default:</strong> 5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<hr><strong>Default:</strong> 25<hr><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||
| `exclude` | **Description:** Exclude these Producers from creating a Dynamic Collection.<br>**Values:** List of Producer Names |
|
||||
| `producer_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> (Producer)`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `producer_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s produced by <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
@ -43,13 +60,11 @@ libraries:
|
|||
metadata_path:
|
||||
- pmm: producer
|
||||
template_variables:
|
||||
style: rainier
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
data:
|
||||
depth: 10
|
||||
limit: 20
|
||||
style: rainier
|
||||
sort_by: title.asc
|
||||
collection_section: 12
|
||||
collection_mode: show_items
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
72
docs/defaults/movie/seasonal.md
Normal file
72
docs/defaults/movie/seasonal.md
Normal file
|
@ -0,0 +1,72 @@
|
|||
# Seasonal Collections
|
||||
|
||||
The `seasonal` Default Metadata File is used to dynamically create seasonal collections based on holidays .
|
||||
|
||||
**This file only works with Movie Libraries.**
|
||||
|
||||
![](../images/seasonal.png)
|
||||
|
||||
## Collections Section 00
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:-----------------------------|:--------------:|:-----------------------------------------------------------|
|
||||
| `Seasonal Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `🎊 New Year's Day Movies` | `years` | Collection of Movies related to New Year's Day. |
|
||||
| `💘 Valentine's Day Movies` | `valentine` | Collection of Movies related to Valentine's Day. |
|
||||
| `☘ St. Patrick's Day Movies` | `patrick` | Collection of Movies related to St. Patrick's Day. |
|
||||
| `🐰 Easter Movies` | `easter` | Collection of Movies related to Easter. |
|
||||
| `🤱 Mother's Day Movies` | `mother` | Collection of Movies related to Mother's Day. |
|
||||
| `🪖 Memorial Day Movies` | `memorial` | Collection of Movies related to Memorial Day. |
|
||||
| `👨 Father's Day Movies` | `father` | Collection of Movies related to Father's Day. |
|
||||
| `🎆 Independence Day Movies` | `independence` | Collection of Movies related to Independence Day. |
|
||||
| `⚒ Labor Day Movies` | `labor` | Collection of Movies related to Labor Day. |
|
||||
| `🎃 Halloween Movies` | `halloween` | Collection of Movies related to Halloween. |
|
||||
| `🦃 Thanksgiving Movies` | `thanksgiving` | Collection of Movies related to Thanksgiving. |
|
||||
| `🎅 Christmas Movies` | `christmas` | Collection of Movies related to Christmas. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: seasonal
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `true` to turn on the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `schedule_<<key>>` | **Description:** Changes the Schedule of the specified key's Collection.<br>**Default:**<table class="clearTable"><tr><td><code>🎊 New Year's Day Movies</code></td><td>range(12/26-01/04)</td></tr><tr><td><code>💘 Valentine's Day Movies</code></td><td>range(02/01-02/29)</td></tr><tr><td><code>☘ St. Patrick's Day Movies</code></td><td>range(03/01-03/18)</td></tr><tr><td><code>🐰 Easter Movies</code></td><td>range(03/20-04/30)</td></tr><tr><td><code>🤱 Mother's Day Movies</code></td><td>range(05/05-05/10)</td></tr><tr><td><code>🪖 Memorial Day Movies</code></td><td>range(5/18-6/7)</td></tr><tr><td><code>👨 Father's Day Movies</code></td><td>range(06/15-06/20)</td></tr><tr><td><code>🎆 Independence Day Movies</code></td><td>range(06/23-07/11)</td></tr><tr><td><code>⚒ Labor Day Movies</code></td><td>range(09/01-09/10)</td></tr><tr><td><code>🎃 Halloween Movies</code></td><td>range(10/01-10/31)</td></tr><tr><td><code>🦃 Thanksgiving Movies</code></td><td>range(11/01-11/30)</td></tr><tr><td><code>🎅 Christmas Movies</code></td><td>range(12/01-12/31)</td></tr></table><br>**Values:** [Any Schedule Option](../../metadata/details/schedule) |
|
||||
| `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.<br>**Values:** List of Seasons Keys |
|
||||
| `seasonal_name` | **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. |
|
||||
| `seasonal_summary` | **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. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: seasonal
|
||||
template_variables:
|
||||
use_separator: true
|
||||
sep_style: stb
|
||||
use_independence: false
|
||||
schedule_thanksgiving: range(10/01-10/30)
|
||||
sort_by: random
|
||||
```
|
|
@ -1,12 +1,28 @@
|
|||
# Writer Default Metadata File
|
||||
# Writer Collections
|
||||
|
||||
The `writer` Metadata File is used to dynamically create collections based on the most popular writers in your library.
|
||||
The `writer` Default Metadata File is used to dynamically create collections based on the most popular writers in your library.
|
||||
|
||||
Example Collections Created:
|
||||
**This file only works with Movie Libraries.**
|
||||
|
||||
![](../images/writer1.png)
|
||||
|
||||
The below YAML in your config.yml will create the writer collections:
|
||||
## Collections Section 20
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:-------------------------------------------------|:------------------------------------------------:|:-----------------------------------------------------------|
|
||||
| `Writers Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `<<writer_name>>`<br>**Example:** `Frank Welker` | `<<writer_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by the Writer. |
|
||||
|
||||
#### Rainier Style
|
||||
|
||||
Below is a screenshot of the alternative Rainier (`rainier`) style which can be set via the `style` template variable.
|
||||
|
||||
![](../images/writer2.png)
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
@ -14,26 +30,27 @@ libraries:
|
|||
- pmm: writer
|
||||
```
|
||||
|
||||
## Rainier Style
|
||||
Below is a screenshot of the alternative `Rainier` style which can be set via template variables
|
||||
|
||||
![](../images/writer2.png)
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the writer file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style ` | **Description:** Controls the visual theme of the collections created<br>**Values:**`bw` - Black and white theme or</br>`rainier` - Rainier theme |
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `style ` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>bw</code></td><td>Black & White Theme</td></tr><tr><td><code>rainier</code></td><td>Rainier Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<hr><strong>Default:</strong> 5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<hr><strong>Default:</strong> 25<hr><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||
| `exclude` | **Description:** Exclude these Writers from creating a Dynamic Collection.<br>**Values:** List of Writer Names |
|
||||
| `writer_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> (Writer)`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `writer_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s written by <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
@ -43,13 +60,11 @@ libraries:
|
|||
metadata_path:
|
||||
- pmm: writer
|
||||
template_variables:
|
||||
style: rainier
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
data:
|
||||
depth: 10
|
||||
limit: 20
|
||||
style: rainier
|
||||
sort_by: title.asc
|
||||
collection_section: 12
|
||||
collection_mode: show_items
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
139
docs/defaults/show/content_rating_us.md
Normal file
139
docs/defaults/show/content_rating_us.md
Normal file
|
@ -0,0 +1,139 @@
|
|||
# US Content Rating Collections
|
||||
|
||||
The `content_rating_us` Default Metadata 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.
|
||||
|
||||
**This file works with TV Libraries, but has a Movie Library [Counterpart](../movie/content_rating_us).**
|
||||
|
||||
![](../images/moviecontent_rating_us.png)
|
||||
|
||||
## Collections Section 14
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:---------------------------------------------------------|:--------------------------------------------:|:-------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | Separator Collection 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
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: content_rating_us
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||
| `content_rating_name` | **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. |
|
||||
| `content_rating_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Not Rated <<library_translationU>>s`<br>**Values:** Any string. |
|
||||
| `content_rating_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `content_rating_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: content_rating_us
|
||||
template_variables:
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: blue
|
||||
append_addons:
|
||||
R:
|
||||
- "de/18"
|
||||
sort_by: title.asc
|
||||
```
|
||||
|
||||
## Default `include`
|
||||
|
||||
```yaml
|
||||
include:
|
||||
- TV-G
|
||||
- TV-Y
|
||||
- TV-PG
|
||||
- TV-14
|
||||
- TV-MA
|
||||
```
|
||||
|
||||
## Default `addons`
|
||||
|
||||
```yaml
|
||||
addons:
|
||||
TV-G:
|
||||
- gb/U
|
||||
- gb/0+
|
||||
- U
|
||||
- G
|
||||
- 1
|
||||
- 2
|
||||
- 3
|
||||
- 4
|
||||
- 5
|
||||
- 6
|
||||
- "01"
|
||||
- "02"
|
||||
- "03"
|
||||
- "04"
|
||||
- "05"
|
||||
- "06"
|
||||
TV-Y:
|
||||
- TV-Y7
|
||||
- TV-Y7-FV
|
||||
- 7
|
||||
- 8
|
||||
- 9
|
||||
- "07"
|
||||
- "08"
|
||||
- "09"
|
||||
TV-PG:
|
||||
- gb/PG
|
||||
- gb/9+
|
||||
- 10
|
||||
- 11
|
||||
- 12
|
||||
- 13
|
||||
TV-14:
|
||||
- gb/12A
|
||||
- 12+
|
||||
- PG-13
|
||||
- TV-13
|
||||
- gb/14+
|
||||
- gb/15
|
||||
- 14
|
||||
- 15
|
||||
- 16
|
||||
- 17
|
||||
TV-MA:
|
||||
- 18
|
||||
- gb/18
|
||||
- MA-17
|
||||
- NC-17
|
||||
- R
|
||||
- TVMA
|
||||
```
|
|
@ -1,54 +1,317 @@
|
|||
# Country Default Metadata File
|
||||
# Country Collections
|
||||
|
||||
The `show/country` Metadata File is used to dynamically create collections based on the countries available in your library.
|
||||
The `country` Default Metadata File is used to dynamically create collections based on the countries available in your library.
|
||||
|
||||
Example Collections Created:
|
||||
**This file works with TV Libraries, but has a Movie Library [Counterpart](../movie/content_rating_us).**
|
||||
|
||||
![](../images/country1.png)
|
||||
|
||||
## Collections Section 09
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:----------------------------------------|:--------------------------------------------------:|:-------------------------------------------------------------|
|
||||
| `Country Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `<<Country>>`<br>**Example:** `Germany` | `<<2 digit ISO 3166-1 code>>`<br>**Example:** `de` | Collection of TV Shows that have this Country. |
|
||||
| `Other Countries` | `other` | Collection of TV Shows that are in other uncommon Countries. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: show/country
|
||||
- pmm: country
|
||||
```
|
||||
|
||||
## Color Style
|
||||
Below is a screenshot of the alternative `color` style which can be set via template variables
|
||||
|
||||
Below is a screenshot of the alternative Color (`color`) style which can be set via the `style` template variable.
|
||||
|
||||
![](../images/country2.png)
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `addons` | **Description:** Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
| Variable | Description & Values |
|
||||
|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `style ` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||
| `addons` | **Description:** Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).`key_name` by `key` |
|
||||
| `country_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `country_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Other Countries`<br>**Values:** Any string. |
|
||||
| `country_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `country_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s filmed in other uncommon Countries.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: country
|
||||
template_variables:
|
||||
exclude:
|
||||
- fr
|
||||
sort_by: title.asc
|
||||
collection_section: 8
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
||||
exclude:
|
||||
- fr
|
||||
sort_by: title.asc
|
||||
```
|
||||
|
||||
## Default `include`
|
||||
|
||||
```yaml
|
||||
include:
|
||||
# - af # Afghanistan
|
||||
# - ax # Åland Islands
|
||||
# - al # Albania
|
||||
# - dz # Algeria
|
||||
# - ad # Andorra
|
||||
# - ao # Angola
|
||||
# - ai # Anguilla
|
||||
# - aq # Antarctica
|
||||
# - ag # Antigua
|
||||
- ar # Argentina
|
||||
# - am # Armenia
|
||||
# - aw # Aruba
|
||||
- au # Australia
|
||||
- at # Austria
|
||||
# - az # Azerbaijan
|
||||
- bs # Bahamas
|
||||
# - bh # Bahrain
|
||||
# - bd # Bangladesh
|
||||
# - bb # Barbados
|
||||
# - by # Belarus
|
||||
- be # Belgium
|
||||
# - bz # Belize
|
||||
# - bj # Benin
|
||||
# - bm # Bermuda
|
||||
# - bt # Bhutan
|
||||
# - bo # Bolivia
|
||||
# - bq # Bonaire
|
||||
# - ba # Bosnia and Herzegovina
|
||||
# - bw # Botswana
|
||||
# - bv # Bouvet Island
|
||||
- br # Brazil
|
||||
# - bn # Brunei
|
||||
- bg # Bulgaria
|
||||
# - bf # Burkina Faso
|
||||
# - bi # Burundi
|
||||
# - cv # Cabo Verde
|
||||
# - kh # Cambodia
|
||||
# - cm # Cameroon
|
||||
- ca # Canada
|
||||
# - ky # Cayman Islands
|
||||
# - cf # Central African Republic
|
||||
# - td # Chad
|
||||
- cl # Chile
|
||||
- cn # China
|
||||
# - cx # Christmas Island
|
||||
# - cc # Cocos (Keeling) Islands
|
||||
# - co # Colombia
|
||||
# - km # Comoros
|
||||
# - cg # Congo
|
||||
# - ck # Cook Islands
|
||||
- cr # Costa Rica
|
||||
# - ci # Côte d'Ivoire
|
||||
- hr # Croatia
|
||||
# - cu # Cuba
|
||||
# - cw # Curaçao
|
||||
# - cy # Cyprus
|
||||
- cz # Czech Republic
|
||||
- dk # Denmark
|
||||
# - dj # Djibouti
|
||||
# - dm # Dominica
|
||||
- do # Dominican Republic
|
||||
# - ec # Ecuador
|
||||
- eg # Egypt
|
||||
# - sv # El Salvador
|
||||
# - gq # Equatorial Guinea
|
||||
# - er # Eritrea
|
||||
- ee # Estonia
|
||||
# - sz # Eswatini
|
||||
# - et # Ethiopia
|
||||
# - fk # Falkland Islands
|
||||
# - fo # Faroe Islands
|
||||
# - fj # Fiji
|
||||
- fi # Finland
|
||||
- fr # France
|
||||
# - gf # French Guiana
|
||||
# - pf # French Polynesia
|
||||
# - ga # Gabon
|
||||
# - gm # Gambia
|
||||
# - ge # Georgia
|
||||
- de # Germany
|
||||
# - gh # Ghana
|
||||
# - gi # Gibraltar
|
||||
- gr # Greece
|
||||
# - gl # Greenland
|
||||
# - gd # Grenada
|
||||
# - gp # Guadeloupe
|
||||
# - gu # Guam
|
||||
# - gt # Guatemala
|
||||
# - gg # Guernsey
|
||||
# - gn # Guinea
|
||||
# - gw # Guinea-Bissau
|
||||
# - gy # Guyana
|
||||
# - ht # Haiti
|
||||
# - va # Holy See
|
||||
# - hn # Honduras
|
||||
- hk # Hong Kong
|
||||
- hu # Hungary
|
||||
- is # Iceland
|
||||
- in # India
|
||||
- id # Indonesia
|
||||
- ir # Iran
|
||||
# - iq # Iraq
|
||||
- ie # Ireland
|
||||
# - im # Isle of Man
|
||||
- il # Israel
|
||||
- it # Italy
|
||||
# - jm # Jamaica
|
||||
- jp # Japan
|
||||
# - je # Jersey
|
||||
# - jo # Jordan
|
||||
# - kz # Kazakhstan
|
||||
# - ke # Kenya
|
||||
# - ki # Kiribati
|
||||
- kr # Korea
|
||||
# - kw # Kuwait
|
||||
# - kg # Kyrgyzstan
|
||||
# - la # Lao
|
||||
- lv # Latvia
|
||||
# - lb # Lebanon
|
||||
# - ls # Lesotho
|
||||
# - lr # Liberia
|
||||
# - ly # Libya
|
||||
# - li # Liechtenstein
|
||||
# - lt # Lithuania
|
||||
- lu # Luxembourg
|
||||
# - mo # Macao
|
||||
# - mg # Madagascar
|
||||
# - mw # Malawi
|
||||
- my # Malaysia
|
||||
# - mv # Maldives
|
||||
# - ml # Mali
|
||||
# - mt # Malta
|
||||
# - mh # Marshall Islands
|
||||
# - mq # Martinique
|
||||
# - mr # Mauritania
|
||||
# - mu # Mauritius
|
||||
# - yt # Mayotte
|
||||
- mx # Mexico
|
||||
# - fm # Micronesia
|
||||
# - md # Moldova
|
||||
# - mc # Monaco
|
||||
# - mn # Mongolia
|
||||
# - me # Montenegro
|
||||
# - ms # Montserrat
|
||||
- ma # Morocco
|
||||
# - mz # Mozambique
|
||||
# - mm # Myanmar
|
||||
# - na # Namibia
|
||||
# - nr # Nauru
|
||||
# - np # Nepal
|
||||
- nl # Netherlands
|
||||
# - nc # New Caledonia
|
||||
- nz # New Zealand
|
||||
# - ni # Nicaragua
|
||||
# - ne # Niger
|
||||
# - ng # Nigeria
|
||||
# - nu # Niue
|
||||
# - nf # Norfolk Island
|
||||
# - mk # Macedonia
|
||||
- no # Norway
|
||||
# - om # Oman
|
||||
- pk # Pakistan
|
||||
# - pw # Palau
|
||||
# - ps # Palestine
|
||||
- pa # Panama
|
||||
# - pg # New Guinea
|
||||
# - py # Paraguay
|
||||
- pe # Peru
|
||||
- ph # Philippines
|
||||
# - pn # Pitcairn
|
||||
- pl # Poland
|
||||
- pt # Portugal
|
||||
# - pr # Puerto Rico
|
||||
- qa # Qatar
|
||||
# - re # Réunion
|
||||
- ro # Romania
|
||||
- ru # Russia
|
||||
# - rw # Rwanda
|
||||
# - bl # Saint Barthélemy
|
||||
# - lc # Saint Lucia
|
||||
# - ws # Samoa
|
||||
# - sm # San Marino
|
||||
# - st # Sao Tome and Principe
|
||||
- sa # Saudi Arabia
|
||||
# - sn # Senegal
|
||||
- rs # Serbia
|
||||
# - sc # Seychelles
|
||||
# - sl # Sierra Leone
|
||||
- sg # Singapore
|
||||
# - sk # Slovakia
|
||||
# - si # Slovenia
|
||||
# - sb # Solomon Islands
|
||||
# - so # Somalia
|
||||
- za # South Africa
|
||||
# - ss # South Sudan
|
||||
- es # Spain
|
||||
- lk # Sri Lanka
|
||||
# - sd # Sudan
|
||||
# - sr # Suriname
|
||||
- se # Sweden
|
||||
- ch # Switzerland
|
||||
# - sy # Syria
|
||||
# - tw # Taiwan
|
||||
# - tj # Tajikistan
|
||||
# - tz # Tanzania
|
||||
- th # Thailand
|
||||
# - tl # Timor-Leste
|
||||
# - tg # Togo
|
||||
# - tk # Tokelau
|
||||
# - to # Tonga
|
||||
# - tt # Trinidad and Tobago
|
||||
# - tn # Tunisia
|
||||
- tr # Turkey
|
||||
# - tm # Turkmenistan
|
||||
# - tc # Turks and Caicos
|
||||
# - tv # Tuvalu
|
||||
# - ug # Uganda
|
||||
- ua # Ukraine
|
||||
- ae # United Arab Emirates
|
||||
- gb # United Kingdom
|
||||
- us # United States of America
|
||||
# - uy # Uruguay
|
||||
# - uz # Uzbekistan
|
||||
# - vu # Vanuatu
|
||||
# - ve # Venezuela
|
||||
- vn # Vietnam
|
||||
# - ye # Yemen
|
||||
# - zm # Zambia
|
||||
# - zw # Zimbabwe
|
||||
```
|
||||
|
||||
## Default `key_name_override`
|
||||
|
||||
```yaml
|
||||
key_name_override:
|
||||
kr: Korea
|
||||
```
|
||||
|
|
|
@ -1,43 +1,59 @@
|
|||
# Decade Default Metadata File
|
||||
# Decade Collections
|
||||
|
||||
The `show/decade` Metadata 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` Metadata 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>"
|
||||
|
||||
Example Collections Created:
|
||||
**This file works with TV Libraries, but has a Movie Library [Counterpart](../movie/decade).**
|
||||
|
||||
![](../images/decade.png)
|
||||
|
||||
## Collections Section 12
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:-----------------------------------------------------|:---------------------------------:|:-----------------------------------------------------------|
|
||||
| `Decade Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `Best of <<Decade>>`<br>**Example:** `Best of 2020s` | `<<Year>>`<br>**Example:** `2020` | Collection of Shows released in this Decade. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: show/decade
|
||||
```
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| Variable | Description & Values |
|
||||
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `critic_rating.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.<br>**Values:** List of Decades found in your library |
|
||||
| `decade_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Best of <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `decade_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Top <<limit>> <<library_translation>>s of the <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: show/decade
|
||||
- pmm: decade
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 18
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
sort_by: title.asc
|
||||
```
|
|
@ -1,36 +1,52 @@
|
|||
# Network Default Metadata File
|
||||
# Network Collections
|
||||
|
||||
The `show/network` Metadata File is used to dynamically create collections based on the networks available in your library.
|
||||
The `network` Default Metadata File is used to dynamically create collections based on the networks available in your library.
|
||||
|
||||
Example Collections Created:
|
||||
**This file only works with TV Libraries.**
|
||||
|
||||
![](../images/network.png)
|
||||
|
||||
## Collections Section 04
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:------------------------------------|:-----------------------------------:|:-----------------------------------------------------------|
|
||||
| `Network Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `<<network>>`<br>**Example:** `NBC` | `<<network>>`<br>**Example:** `NBC` | Collection of Shows the aired on the network. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: show/network
|
||||
- pmm: network
|
||||
```
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `addons` | **Description:** Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
| Variable | Description & Values |
|
||||
|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Networks found in your library |
|
||||
| `exclude` | **Description:** Exclude these Networks from creating a Dynamic Collection.<br>**Values:** List of of Networks found in your library |
|
||||
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Networks found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Networks found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Networks found in your library |
|
||||
| `network_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `network_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s broadcast on <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
@ -40,12 +56,265 @@ libraries:
|
|||
metadata_path:
|
||||
- pmm: show/show/network
|
||||
template_variables:
|
||||
use_separator: false
|
||||
sep_style: stb
|
||||
append_exclude:
|
||||
- BBC
|
||||
sort_by: title.asc
|
||||
collection_section: 07
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: stb
|
||||
```
|
||||
```
|
||||
|
||||
|
||||
## Default `include`
|
||||
|
||||
```yaml
|
||||
include:
|
||||
- A&E
|
||||
- ABC
|
||||
- Amazon
|
||||
- AMC
|
||||
- Animal Planet
|
||||
- BBC
|
||||
- BET
|
||||
- Cartoon Network
|
||||
- Channel 4
|
||||
- Channel 5
|
||||
- CBC
|
||||
- CBS
|
||||
- Comedy Central
|
||||
- Discovery
|
||||
- Disney Channel
|
||||
- E!
|
||||
- ESPN
|
||||
- Food Network
|
||||
- FOX
|
||||
- Hallmark
|
||||
- HBO
|
||||
- HGTV
|
||||
- History
|
||||
- ITV
|
||||
- Lifetime
|
||||
- MTV
|
||||
- National Geographic
|
||||
- NBC
|
||||
- Nickelodeon
|
||||
- PBS
|
||||
- Showtime
|
||||
- Sky
|
||||
- Starz
|
||||
- The CW
|
||||
- TLC
|
||||
- TNT
|
||||
- UKTV
|
||||
- USA
|
||||
- YouTube
|
||||
```
|
||||
|
||||
## Default `addons`
|
||||
|
||||
```yaml
|
||||
addons:
|
||||
A&E:
|
||||
- A+E Networks UK
|
||||
ABC:
|
||||
- ABC (AU)
|
||||
- ABC (US)
|
||||
- ABC Comedy
|
||||
- ABC Family
|
||||
- ABC Kids
|
||||
- ABC Me
|
||||
- ABC Signature
|
||||
- ABC Spark
|
||||
- ABC Studios
|
||||
- ABC.com
|
||||
- Freeform
|
||||
Amazon:
|
||||
- Amazon (Japan)
|
||||
- Amazon Kids+
|
||||
- Amazon Prime Video
|
||||
- Amazon Productions
|
||||
- Amazon Studios
|
||||
- Prime
|
||||
- Prime Video
|
||||
AMC:
|
||||
- AMC+
|
||||
Animal Planet:
|
||||
- Animal Planet (CA)
|
||||
- Animal Planet (UK)
|
||||
BBC:
|
||||
- BBC Alba
|
||||
- BBC America
|
||||
- BBC Choice
|
||||
- BBC First
|
||||
- BBC Four
|
||||
- BBC HD
|
||||
- BBC iPlayer
|
||||
- BBC Kids
|
||||
- BBC Knowledge
|
||||
- BBC News
|
||||
- BBC One
|
||||
- BBC One Northern Ireland
|
||||
- BBC Scotland
|
||||
- BBC Television
|
||||
- BBC Three
|
||||
- BBC Two
|
||||
- BBC UKTV
|
||||
- BBC Wales
|
||||
- BBC World News
|
||||
- CBBC
|
||||
- CBeebies
|
||||
BET:
|
||||
- BET+
|
||||
Cartoon Network:
|
||||
- Cartoonito
|
||||
Channel 4:
|
||||
- 4seven
|
||||
- All 4
|
||||
- E4
|
||||
- More4
|
||||
Channel 5:
|
||||
- Channel 5 (UK)
|
||||
- 5Action
|
||||
- 5Select
|
||||
- 5Star
|
||||
- 5USA
|
||||
CBC:
|
||||
- CBC (CA)
|
||||
- CBC Gem
|
||||
- CBC Television
|
||||
CBS:
|
||||
- CBS All Access
|
||||
- CBS Reality
|
||||
- CBS Reality (UK)
|
||||
- CBS.com
|
||||
Comedy Central:
|
||||
- Comedy Central (UK)
|
||||
Discovery:
|
||||
- Discovery Asia
|
||||
- Discovery Channel
|
||||
- Discovery Channel (Asia)
|
||||
- Discovery Channel (AU)
|
||||
- Discovery Channel (CA)
|
||||
- Discovery Channel (UK)
|
||||
- Discovery Family
|
||||
- Discovery Health Channel
|
||||
- Discovery Kids
|
||||
- Discovery Life
|
||||
- Discovery Real Time
|
||||
- Discovery Turbo
|
||||
- Discovery Turbo UK
|
||||
- discovery+
|
||||
- Discovery+ (IN)
|
||||
- Discovery+ (NO)
|
||||
- Discovery+ (SE)
|
||||
- Discovery+ (UK)
|
||||
Disney Channel:
|
||||
- Disney Channel (CZ)
|
||||
- Disney Channel (UK)
|
||||
- Disney Junior
|
||||
- Disney XD
|
||||
- Disney+
|
||||
- Playhouse Disney
|
||||
- Toon Disney
|
||||
E!:
|
||||
- e.tv
|
||||
ESPN:
|
||||
- ESPN+
|
||||
Food Network:
|
||||
- Cooking Channel
|
||||
FOX:
|
||||
- Fox Action Movies
|
||||
- Fox Business Network
|
||||
- FOX España
|
||||
- Fox Kids
|
||||
- Fox Nation
|
||||
- Fox Premium Series
|
||||
- FOX Sports 1
|
||||
- Fox Sports Networks
|
||||
- Fox8
|
||||
- FX
|
||||
- FXX
|
||||
Hallmark:
|
||||
- Hallmark Channel
|
||||
- Hallmark Movies & Mysteries
|
||||
- Hallmark Movies Now
|
||||
HBO:
|
||||
- HBO2
|
||||
- HBO Asia
|
||||
- HBO Canada
|
||||
- HBO Comedy
|
||||
- HBO España
|
||||
- HBO Europe
|
||||
- HBO Family
|
||||
- HBO Latin America
|
||||
- HBO Nordic
|
||||
- HBO Signature
|
||||
- HBO Zone
|
||||
History:
|
||||
- History (CA)
|
||||
- History (UK)
|
||||
ITV:
|
||||
- ITV Encore
|
||||
- ITV Wales
|
||||
- ITV1
|
||||
- ITV2
|
||||
- ITV4
|
||||
- ITVBe
|
||||
- CITV
|
||||
- STV
|
||||
Lifetime:
|
||||
- Lifetime Movies
|
||||
MTV:
|
||||
- MTV (AU/NZ)
|
||||
- MTV (UK)
|
||||
- MTV Japan
|
||||
- MTV Nederland
|
||||
- MTV2
|
||||
- MTV3
|
||||
National Geographic:
|
||||
- Nat Geo Wild
|
||||
- National Geographic Brasil
|
||||
- National Geographic Channel
|
||||
- National Geographic Wild
|
||||
Nickelodeon:
|
||||
- Nick at Nite
|
||||
- Nick Jr.
|
||||
- Nicktoons
|
||||
- TeenNick
|
||||
PBS:
|
||||
- PBS Kids
|
||||
Sky:
|
||||
- Sky 1
|
||||
- Sky Arts
|
||||
- Sky Atlantic
|
||||
- "Sky Atlantic "
|
||||
- Sky Atlantic (UK)
|
||||
- Sky Cinema
|
||||
- Sky Crime
|
||||
- Sky Deutschland
|
||||
- Sky Documentaries
|
||||
- Sky History
|
||||
- Sky Living
|
||||
- Sky Max
|
||||
- Sky Nature
|
||||
- Sky One
|
||||
- Sky Showcase
|
||||
- Sky Sports
|
||||
- Sky Two
|
||||
- Sky Witness
|
||||
- Sky1
|
||||
The CW:
|
||||
- CW seed
|
||||
TLC:
|
||||
- TLC Go
|
||||
- TLC UK
|
||||
TNT:
|
||||
- TNT (US)
|
||||
UKTV:
|
||||
- UKTV Food
|
||||
- UKTV History
|
||||
- UKTV Yesterday
|
||||
USA:
|
||||
- USA Network
|
||||
YouTube:
|
||||
- YouTube Premium
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue