10 KiB
Writer Collections
The writer
Default Metadata File is used to dynamically create collections based on the most popular writers in your library.
Requirements & Recommendations
Supported Library Types: Movie
Collections Section 170
Collection | Key | Description |
---|---|---|
Writers Collections |
separator |
Separator Collection to denote the Section of Collections. |
<<writer_name>> Example: Frank Welker |
<<writer_name>> Example: Frank Welker |
Collection of Movies by the Writer. |
Config
The below YAML in your config.yml will create the collections:
libraries:
Movies:
metadata_path:
- pmm: writer
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 | ||||||
---|---|---|---|---|---|---|---|
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 then 0 |
||||||
limit_<<key>> 1 |
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: release.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 |
||||||
data |
Description: Replaces the data dynamic collection value.
|
||||||
include |
Description: Force these Actors to be included to create a Dynamic Collection. Values: List of Actor Names |
||||||
exclude |
Description: Exclude these Writers from creating a Dynamic Collection. Values: List of Writer Names |
||||||
name_format |
Description: Changes the title format of the Dynamic Collections. Default: <<key_name>> (Writer) Values: Any string with <<key_name>> in it. |
||||||
summary_format |
Description: Changes the summary format of the Dynamic Collections. Default: <<library_translationU>>s written by <<key_name>>. Values: Any string with <<key_name>> in it. |
||||||
tmdb_birthday |
Description: Has 2 possible attributes before and after which represents the number of days before/after the tmdb_person 's birthday which allows the definition to run.Values: Any Number 0 or greater Default: 0 |
||||||
tmdb_person_offset_<<key>> 1 |
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.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
libraries:
Movies:
metadata_path:
- pmm: writer
template_variables:
style: signature
use_separator: false
sep_style: purple
data:
depth: 10
limit: 20
sort_by: title.asc
tmdb_person_offset_Charles Bennett: 1