4.6 KiB

Raw Blame History

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 "

This file has a Movie Library Counterpart.

Requirements & Recommendations

Supported Library Types: Show

Collections Section 12

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:
    metadata_path:
      - pmm: decade

Template Variables

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

Note that the template_variables: section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.

All Shared Collection Variables are available as well as the additional Variables below which can be used to customize the file.

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 then 0
`limit_<<key>>`¹	Description: Changes the Builder Limit of the specified key's collection. Default: `limit` Values: Number Greater then 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>>`¹	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
`decade_name`	Description: Changes the title format of the Dynamic Collections. Default: `Best of <<key_name>>` Values: Any string with `<<key_name>>` in it.
`decade_summary`	Description: Changes the summary format of the Dynamic Collections. Default: `Top <<limit>> <<library_translation>>s of the <<key_name>>.` Values: Any string.

Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

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

libraries:
  TV Shows:
    metadata_path:
      - pmm: decade
        template_variables:
          use_other: false
          use_separator: false
          sep_style: purple
          sort_by: title.asc

4.6 KiB Raw Blame History