10 KiB

Raw Blame History

Director Collections

The director Default Collection File is used to dynamically create collections based on the most popular directors in your library.

Requirements & Recommendations

Supported Library Types: Movie

Collections Section 150

Collection	Key	Description
`Directors Collections`	`separator`	Separator Collection to denote the Section of Collections.
`<<director_name>>` Example: `Frank Welker`	`<<director_name>>` Example: `Frank Welker`	Collection of Movies by the Director.

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

Config

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

libraries:
  Movies:
    collection_files:
      - pmm: director

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

style Description: Controls the visual theme of the collections created.
Default: bw
Values: bw, rainier, signature, diiivoy, or diiivoycolor

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

data

Description: Replaces the data dynamic collection value.

Attribute	Description & Values
`depth`	Controls the depth within the casting credits to search for common actors Default: 5 Values: Number greater than 0
`limit`	Controls the maximum number of collections to create Default: 25 Values: Number greater than 0

include Description: Force these Actors to be included to create a Dynamic Collection.
Values: List of Actor Names

exclude Description: Exclude these Directors from creating a Dynamic Collection.
Values: List of Director Names

name_format Description: Changes the title format of the Dynamic Collections.
Default: <<key_name>> (Director)
Values: Any string with <<key_name>> in it.

summary_format Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s directed by <<key_name>>.
Values: Any string with <<key_name>> in it.

tmdb_birthday

Description: Controls if the Definition is run based on tmdb_person's Birthday. Has 3 possible attributes this_month, before and after.
Values:

`this_month`	Run's if Birthday is in current Month	`true`/`false`
`before`	Run if X Number of Days before the Birthday	Number 0 or greater
`after`	Run if X Number of Days after the Birthday	Number 0 or greater

tmdb_person_offset_<<key>>¹ Description: Changes the summary tmdb_person_offset for the specific key.
Default: 0
Values: Dictionary of Actor Name as the keys and the tmdb_person_offset as the value.

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: director
        template_variables:
          data:
            depth: 10 #(1)!
            limit: 20 #(2)!
          style: rainier #(3)!
          sort_by: title.asc
          use_separator: false #(4)!
          tmdb_person_offset_Richard Brooks: 1 #(5)!

Check the first 10 casting credits in each movie
Create 20 collections maximum
use the rainier Style
Do not create a "Directors Collections" separator
There are two Richard Brooks, so use the 2nd Richard Brooks found on TMDb

10 KiB Raw Blame History