Plex-Meta-Manager/docs/defaults/award/separator.md
2022-10-17 02:48:08 -04:00

5.1 KiB

Award Separator Collections

The separator_award Default Metadata File is used to create a seperator collection for Awards.

This file works with Movie and TV Libraries.

Collections Section 16

Collection Key Description
Award Collections separator Separator Collection to denote the Section of Collections.

Config

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

libraries:
  Movies:
    metadata_path:
      - pmm: separator_award
  TV Shows:
    metadata_path:
      - pmm: separator_award

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

Shared Collection Variables are NOT available to this default file.

Variable Description & Values
use_separator Description: Turn the Separator Collection off.
Values: false to turn of the collection
sep_style Description: Choose the Separator Style.
Default: orig
Values: orig, red, blue, green, gray, purple, or stb
name_separator Description: Changes the name of the specified key's collection.
Values: New Collection Name
summary_separator Description: Changes the summary of the specified key's collection.
Values: New Collection Summary
collection_section Description: Changes the sort order of the collection sections against other default collection sections.
Values: Any number
collection_mode Description: Controls the collection mode of all collections in a Defaults file.
Values:
defaultLibrary default
hideHide Collection
hide_itemsHide Items in this Collection
show_itemsShow this Collection and its Items
url_poster_separator Description: Changes the poster url of the specified key's collection.
Values: URL directly to the Image

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: separator_award
        template_variables:
          use_separator: false
          sep_style: purple