6.5 KiB

Raw Blame History

Aspect Ratio Collections

The aspect Default Collection File is used to create collections with items that are based on their aspect ratio.

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 125

Collection	Key	Description
`Aspect Ratio Collections`	`separator`	Separator Collection to denote the Section of Collections.
`1.33 - Academy Aperture`	`1.33`	Collection of Movies/Shows with a 1.33 aspect ratio
`1.65 - Early Widescreen`	`1.65`	Collection of Movies/Shows with a 1.65 aspect ratio
`1.66 - European Widescreen`	`1.66`	Collection of Movies/Shows with a 1.66 aspect ratio
`1.78 - Widescreen TV`	`1.78`	Collection of Movies/Shows with a 1.78 aspect ratio
`1.85 - American Widescreen`	`1.85`	Collection of Movies/Shows with a 1.85 aspect ratio
`2.2 - 70mm Frame`	`2.2`	Collection of Movies/Shows with a 2.2 aspect ratio
`2.35 - Anamorphic Projection`	`2.35`	Collection of Movies/Shows with a 2.35 aspect ratio
`2.77 - Cinerama`	`2.77`	Collection of Movies/Shows with a 2.77 aspect ratio

Config

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

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

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.
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

sync_mode

Description: Changes the Sync Mode for all collections in a Defaults file.
Default: sync
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

sync_mode_<<key>>¹

Description: Changes the Sync Mode of the specified key's collection.
Default: sync_mode
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

exclude Description: Exclude these Media Outlets from creating a Dynamic Collection.
Values: List of Media Outlet Keys

name_format Description: Changes the title format of the Dynamic Collections.
Default: Based on a <<key_name>>
Values: Any string with <<key_name>> in it.

summary_format Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s based on or inspired by <<translated_key_name>>s.
Values: Any string.

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" %}

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: aspect
        template_variables:
          use_1.65: false #(1)!
          sep_style: plum #(2)!

Do not create a "1.65 - Early Widescreen" collection
Use the plum Separator Style

6.5 KiB Raw Blame History