17 KiB

Raw Blame History Unescape Escape

Continent Collections

The continent Default Collection File is used to dynamically create collections based on the countries within your library. The collection aims to be inclusive, with all 230 countries incorporated into seven continents.

This file has a Show Library Counterpart.

Requirements & Recommendations

Supported Library Types: Movie

Collections Section 082

Collection	Key	Description
`Continent Collections`	`separator`	Separator Collection to denote the Section of Collections.
`<<Continent>>` Example: `South America`	`<<Continent>>` Example: `South America`	Collection of Movies that have this Continent.
`Other Continents`	`other`	Collection of Movies that are in other uncommon Continents.

Config

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

libraries:
  Movies:
    collection_files:
      - pmm: continent

Color Style

Below is a screenshot of the alternative Color (color) style which can be set via the style template variable.

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

Values:
`white`	White Theme
`color`	Color Theme

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

include Description: Overrides the default include list.
Values: List of Countries found in your library

exclude Description: Exclude these Countries from creating a Dynamic Collection.
Values: List of Countries found in your library

addons Description: Overrides the default addons dictionary. Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
Values: Dictionary List of Countries found in your library

append_include Description: Appends to the default include list.
Values: List of Countries found in your library

remove_include Description: Removes from the default include list.
Values: List of Countries found in your library

append_addons Description: Appends to the default addons dictionary.
Values: Dictionary List of Countries found in your library

remove_addons Description: Removes from the default addons dictionary.
Values: Dictionary List of Countries found in your library

name_format Description: Changes the title format of the Dynamic Collections.
Default: <<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 filmed in <<key_name>>.
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: continent
        template_variables:
          use_other: false #(1)!
          use_separator: false #(2)!
          style: color #(3)!
          exclude:
            - Europe #(4)!
          sort_by: title.asc

Do not create the "Other Continents" collection
Do not create a "Continent Collections" separator
Set the Color Style
Exclude "Europe" from the list of collections that are created

Default values

The following yml is provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.

Default `include`

    include:
      - Africa
      - Americas
      - Antarctica
      - Asia
      - Europe
      - Oceania

Default `addons`

    addons:
      Africa:
      # Northern Africa:
        - Algeria
        - Egypt
        - Libya
        - Morocco
        - Sudan
        - Tunisia
        - Western Sahara
      # Eastern Africa:
        - British Indian Ocean Territory
        - Burundi
        - Comoros
        - Djibouti
        - Eritrea
        - Ethiopia
        - French Southern Territories
        - Kenya
        - Madagascar
        - Malawi
        - Mauritius
        - Mayotte
        - Mozambique
        - Réunion
        - Rwanda
        - Seychelles
        - Somalia
        - South Sudan
        - Uganda
        - Tanzania
        - United Republic of Tanzania # Tanzania
        - Zambia
        - Zimbabwe
      # Central Africa:
        - Angola
        - Cameroon
        - Central African Republic
        - Chad
        - Republic of the Congo
        - Congo # Republic of the Congo
        - Democratic Republic of the Congo
        - Zaire # Democratic Republic of the Congo
        - Equatorial Guinea
        - Gabon
        - São Tomé and Príncipe
        - Sao Tome and Principe # São Tomé and Príncipe
      # Southern Africa:
        - Botswana
        - Eswatini
        - Swaziland # Eswatini
        - Lesotho
        - Namibia
        - South Africa
      # Western Africa:
        - Benin
        - Burkina Faso
        - Cape Verde
        - Cabo Verde # Cape Verde
        - Côte d'Ivoire
        - Côte d’Ivoire # Côte d'Ivoire
        - Ivory Coast # Côte d'Ivoire
        - Gambia
        - Ghana
        - Guinea
        - Guinea-Bissau
        - Liberia
        - Mali
        - Mauritania
        - Niger
        - Nigeria
        - Saint Helena, Ascension and Tristan da Cunha
        - Saint Helena # Saint Helena, Ascension and Tristan da Cunha
        - St. Helena # Saint Helena, Ascension and Tristan da Cunha
        - Ascension # Saint Helena, Ascension and Tristan da Cunha
        - Tristan da Cunha # Saint Helena, Ascension and Tristan da Cunha
        - Senegal
        - Sierra Leone
        - Togo
      Americas:
      # Caribbean:
        - Anguilla
        - Antigua and Barbuda
        - Antigua # Antigua and Barbuda
        - Barbuda # Antigua and Barbuda
        - Aruba
        - Bahamas
        - Barbados
        - Bonaire, Sint Eustatius and Saba
        - Bonaire # Bonaire, Sint Eustatius and Saba
        - Sint Eustatius # Bonaire, Sint Eustatius and Saba
        - Saba # Bonaire, Sint Eustatius and Saba
        - Netherlands Antilles
        - British Virgin Islands
        - Cayman Islands
        - Cuba
        - Curaçao
        - Dominica
        - Dominican Republic
        - Grenada
        - Guadeloupe
        - Haiti
        - Jamaica
        - Martinique
        - Montserrat
        - Puerto Rico
        - Saint Barthélemy
        - Saint Kitts and Nevis
        - St. Kitts and Nevis # Saint Kitts and Nevis
        - Saint Lucia
        - St. Lucia # Saint Lucia
        - Saint Martin
        - Saint Vincent and the Grenadines
        - Saint Vincent and Grenadines # Saint Vincent and the Grenadines
        - St. Vincent and the Grenadines # Saint Vincent and the Grenadines
        - St. Vincent and Grenadines # Saint Vincent and the Grenadines
        - Sint Maarten
        - Trinidad and Tobago
        - Turks and Caicos Islands
        - US Virgin Islands
        - U.S. Virgin Islands # US Virgin Islands
        - United States Virgin Islands # US Virgin Islands
      # Central America:
        - Belize
        - Costa Rica
        - El Salvador
        - Guatemala
        - Honduras
        - Mexico
        - Nicaragua
        - Panama
      # South America:
        - Argentina
        - Bolivia
        - Plurinational State of Bolivia # Bolivia
        - Bouvet Island
        - Brazil
        - Chile
        - Colombia
        - Ecuador
        - Falkland Islands
        - Malvinas # Falkland Islands
        - French Guiana
        - Guyana
        - Paraguay
        - Peru
        - South Georgia and the South Sandwich Islands
        - South Georgia and South Sandwich Islands # South Georgia and the South Sandwich Islands
        - South Georgia # South Georgia and the South Sandwich Islands
        - South Sandwich Islands # South Georgia and the South Sandwich Islands
        - Suriname
        - Uruguay
        - Venezuela
        - Bolivarian Republic of Venezuela # Venezuela
      # North America:
        - Bermuda
        - Canada
        - Greenland
        - Saint Pierre and Miquelon
        - St. Pierre and Miquelon # Saint Pierre and Miquelon
        - United States
        - United States of America # United States
      Antarctica:
        - Antarctica
      Asia:
      # Central Asia:
        - Kazakhstan
        - Kyrgyzstan
        - Tajikistan
        - Turkmenistan
        - Uzbekistan
      # Eastern Asia:
        - China
        - Hong Kong
        - Hong Kong SAR China # Hong Kong
        - Macao
        - Macau # Macao
        - Macau SAR China # Macao
        - North Korea
        - Democratic People's Republic of Korea # North Korea
        - Japan
        - Mongolia
        - South Korea
        - Republic of Korea # South Korea
        - Korea # South Korea
        - Taiwan
        - Taiwan, Province of China # Taiwan
      # South-Eastern Asia:
        - Brunei
        - Brunei Darussalam # Brunei
        - Cambodia
        - Indonesia
        - Laos
        - Lao People's Democratic Republic # Laos
        - Lao # Laos
        - Malaysia
        - Myanmar
        - Burma # Myanmar
        - Philippines
        - Singapore
        - Thailand
        - East Timor
        - Timor-Leste # East Timor
        - Vietnam
        - Viet Nam # Vietnam
      # Southern Asia:
        - Afghanistan
        - Bangladesh
        - Bhutan
        - India
        - Iran
        - Islamic Republic of Iran # Iran
        - Maldives
        - Nepal
        - Pakistan
        - Sri Lanka
      # Western Asia:
        - Armenia
        - Azerbaijan
        - Bahrain
        - Cyprus
        - Georgia
        - Iraq
        - Israel
        - Jordan
        - Kuwait
        - Lebanon
        - Oman
        - Qatar
        - Saudi Arabia
        - Palestine
        - State of Palestine # Palestine
        - Syria
        - Syrian Arab Republic # Syria
        - Turkey
        - Türkiye # Turkey
        - United Arab Emirates
        - Yemen
      Europe:
      # Eastern Europe:
        - Belarus
        - Bulgaria
        - Czech Republic
        - Czechia # Czech Republic
        - Czechoslovakia # Czech Republic
        - Hungary
        - Poland
        - Moldova
        - Republic of Moldova # Moldova
        - Romania
        - Russia
        - Russian Federation # Russia
        - Soviet Union
        - Slovakia
        - Ukraine
      # Northern Europe:
        - Åland Islands
        - Guernsey
        - Jersey
        - Sark
        - Denmark
        - Estonia
        - Faroe Islands
        - Finland
        - Iceland
        - Ireland
        - Northern Ireland
        - Isle of Man
        - Latvia
        - Lithuania
        - Norway
        - Svalbard and Jan Mayen Islands
        - Svalbard and Jan Mayen # Svalbard and Jan Mayen Islands
        - Sweden
        - United Kingdom
      # Southern Europe:
        - Albania
        - Andorra
        - Bosnia and Herzegovina
        - Croatia
        - Gibraltar
        - Greece
        - Kosovo
        - Vatican City
        - Holy See # Vatican City
        - Italy
        - Malta
        - Montenegro
        - North Macedonia
        - Macedonia # North Macedonia
        - Republic of North Macedonia # North Macedonia
        - Portugal
        - San Marino
        - Serbia
        - Serbia and Montenegro
        - Slovenia
        - Spain
        - Yugoslavia
      # Western Europe:
        - Austria
        - Belgium
        - France
        - French Republic # France
        - Germany
        - East Germany
        - Liechtenstein
        - Luxembourg
        - Monaco
        - Netherlands
        - Switzerland
      Oceania:
      # Australia and New Zealand:
        - Australia
        - Christmas Island
        - Cocos (Keeling) Islands
        - Heard Island and McDonald Islands
        - Heard and McDonald Islands # Heard Island and McDonald Islands
        - New Zealand
        - Norfolk Island
      # Melanesia:
        - Fiji
        - New Caledonia
        - Papua New Guinea
        - New Guinea # Papua New Guinea
        - Solomon Islands
        - Vanuatu
      # Micronesia:
        - Guam
        - Kiribati
        - Marshall Islands
        - Micronesia
        - Federated States of Micronesia # Micronesia
        - Nauru
        - Northern Mariana Islands
        - Palau
        - US Minor Outlying Islands
        - United States Minor Outlying Islands # US Minor Outlying Islands
        - United States Outlying Islands # US Minor Outlying Islands
        - U.S. Minor Outlying Islands # US Minor Outlying Islands
        - U.S. Outlying Islands # US Minor Outlying Islands
        - US Outlying Islands # US Minor Outlying Islands
      # Polynesia:
        - American Samoa
        - Cook Islands
        - French Polynesia
        - Niue
        - Pitcairn
        - Pitcairn Islands # Pitcairn
        - Samoa
        - Tokelau
        - Tonga
        - Tuvalu
        - Wallis and Futuna Islands
        - Wallis and Futuna # Wallis and Futuna Islands

17 KiB Raw Blame History Unescape Escape