11 KiB

Raw Blame History

Year Collections

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

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 105

Collection	Key	Description
`Year Collections`	`separator`	Separator Collection to denote the Section of Collections.
`Best of <<Year>>` Example: `Best of 2022`	`<<Year>>` Example: `2022`	Collection of Movies/Shows that have this Year.

Config

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

libraries:
  Movies:
    collection_files:
      - pmm: year
  TV Shows:
    collection_files:
      - pmm: year

Template Variables

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

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

??? info "Click to expand"

=== "File-Specific Template Variables"

    The below template variables are available specifically for this PMM Defaults file.

    Be sure to also check out the "Shared Template Variables" tab for additional variables.

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: 10
Values: Number Greater than 0

limit_<<key>>¹ Description: Changes the Builder Limit of the specified key's collection.
Default: limit
Values: Number Greater than 0

sort_by Description: Changes the Smart Filter Sort for all collections in a Defaults file.
Default: release.desc
Values: Any smart_filter Sort Option

sort_by_<<key>>¹ Description: Changes the Smart Filter Sort of the specified key's collection.
Default: sort_by
Values: Any smart_filter Sort Option

data

Description: Replaces the data dynamic collection value.

Attribute	Description & Values
`starting`	Controls the starting year for collections Default: current_year-10 Values: Number greater than 0
`ending`	Controls the ending year for collections Default: current_year Values: Number greater than 1
`increment`	Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0

starting and ending can also have the value current_year
You can also use a value relative to the current_year by doing current_year-5

exclude Description: Exclude these Years from creating a Dynamic Collection.
Values: List of Years

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

=== "Shared Template Variables"
```
 {%
   include-markdown "../collection_variables.md"
 %}
```
Example Template Variable Amendments

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

???+ tip
```
 Anywhere you see this icon:

 > :fontawesome-solid-circle-plus:

 That's a tooltip, you can press them to get more information.

 {%
   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_2022: release.desc #(2)!

Use the purple Separator Style
Set the sort order for "Best of 2022" to release date descending

11 KiB Raw Blame History