You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Plex-Meta-Manager/docs/defaults/show/decade.md

4.7 KiB

Decade Collections

The decade Collection File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of "

This file has a Movie Library Counterpart.

Requirements & Recommendations

Supported Library Types: Show

Collections Section 100

Collection Key Description
Decade Collections separator Separator Collection to denote the Section of Collections.
Best of <<Decade>>
Example: Best of 2020s
<<Year>>
Example: 2020
Collection of Shows released in this Decade.

Config

The below YAML in your config.yml will create the collections:

libraries:
  TV Shows:
    collection_files:
      - pmm: decade

Template Variable Default Values

Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.

This file contains a Separator so all Shared Separator Variables are available as well.

Variable Description & Values
limit Description: Changes the Builder Limit for all collections in a Defaults file.
Default: 100
Values: Number Greater than 0
limit_<<key>>1 Description: Changes the Builder Limit of the specified key's collection.
Default: limit
Values: Number Greater than 0
sort_by Description: Changes the Smart Filter Sort for all collections in a Defaults file.
Default: critic_rating.desc
Values: Any smart_filter Sort Option
sort_by_<<key>>1 Description: Changes the Smart Filter Sort of the specified key's collection.
Default: sort_by
Values: Any smart_filter Sort Option
exclude Description: Exclude these Decades from creating a Dynamic Collection.
Values: List of Decades found in your library
name_format Description: Changes the title format of the Dynamic Collections.
Default: Best of <<key_name>>
Values: Any string with <<key_name>> in it.
summary_format Description: Changes the summary format of the Dynamic Collections.
Default: Top <<limit>> <<library_translation>>s of the <<key_name>>.
Values: Any string.
  1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

{% include-markdown "../collection_variables.md" %} {% include-markdown "../collection_variables.md" %}

Example Template Variable Amendments

The below is an example config.yml extract with some Template Variables added in to change how the file works.

???+ tip

Anywhere you see this icon:

> :fontawesome-solid-circle-plus:

That's a tooltip, you can press them to get more information.
libraries:
  Movies:
    collection_files:
      - pmm: year
        template_variables:
          sep_style: purple #(1)!
          sort_by: title.asc 
          sort_by_2020: release.desc #(2)!
  1. Use the purple Separator Style
  2. Set the sort order for "Best of 2020s" to release date descending