|
|
# Country Collections
|
|
|
|
|
|
The `country` Default Metadata File is used to dynamically create collections based on the countries available in your library.
|
|
|
|
|
|
**This file has a Show Library [Counterpart](../show/country).**
|
|
|
|
|
|
|
|
|
|
|
|
## Requirements & Recommendations
|
|
|
|
|
|
Supported Library Types: Movie
|
|
|
|
|
|
## Collections Section 080
|
|
|
|
|
|
| Collection | Key | Description |
|
|
|
|:----------------------------------------|:----------------------------------------|:----------------------------------------------------------------------------|
|
|
|
| `Country Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
|
|
|
| `<<Country>>`<br>**Example:** `Germany` | `<<Country>>`<br>**Example:** `Germany` | Collection of Movies that have this Country. |
|
|
|
| `Other Countries` | `other` | Collection of Movies that are in other uncommon Countries. |
|
|
|
|
|
|
## Config
|
|
|
|
|
|
The below YAML in your config.yml will create the collections:
|
|
|
|
|
|
```yaml
|
|
|
libraries:
|
|
|
Movies:
|
|
|
metadata_path:
|
|
|
- pmm: country
|
|
|
```
|
|
|
|
|
|
## Color Style
|
|
|
|
|
|
Below is a screenshot of the alternative Color (`color`) style which can be set via the `style` template variable.
|
|
|
|
|
|
|
|
|
|
|
|
## 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](../collection_variables) are available as well as the additional Variables below which can be used to customize the file.
|
|
|
|
|
|
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
|
|
|
|
|
| Variable | Description & Values |
|
|
|
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
|
|
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
|
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
|
|
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
|
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
|
|
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Countries found in your library |
|
|
|
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of Countries found in your library |
|
|
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Countries found in your library |
|
|
|
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Countries found in your library |
|
|
|
| `remove_include` | **Description:** Removes from the [default include list](#default-include).<br>**Values:** List of Countries found in your library |
|
|
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Countries found in your library |
|
|
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Countries found in your library |
|
|
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
|
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
|
|
|
|
|
1. 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.
|
|
|
|
|
|
```yaml
|
|
|
libraries:
|
|
|
Movies:
|
|
|
metadata_path:
|
|
|
- pmm: country
|
|
|
template_variables:
|
|
|
use_other: false
|
|
|
use_separator: false
|
|
|
style: color
|
|
|
sep_style: purple
|
|
|
exclude:
|
|
|
- France
|
|
|
sort_by: title.asc
|
|
|
```
|
|
|
|
|
|
## Default values
|
|
|
|
|
|
These are lists 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`
|
|
|
|
|
|
```yaml
|
|
|
include:
|
|
|
# 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
|
|
|
- Zambia
|
|
|
- Zimbabwe
|
|
|
# Central Africa:
|
|
|
- Angola
|
|
|
- Cameroon
|
|
|
- Central African Republic
|
|
|
- Chad
|
|
|
- Republic of the Congo
|
|
|
- Democratic Republic of the Congo
|
|
|
- Equatorial Guinea
|
|
|
- Gabon
|
|
|
- São Tomé and Príncipe
|
|
|
# Southern Africa:
|
|
|
- Botswana
|
|
|
- Eswatini
|
|
|
- Lesotho
|
|
|
- Namibia
|
|
|
- South Africa
|
|
|
# Western Africa:
|
|
|
- Benin
|
|
|
- Burkina Faso
|
|
|
- Cape Verde
|
|
|
- Côte d'Ivoire
|
|
|
- Gambia
|
|
|
- Ghana
|
|
|
- Guinea
|
|
|
- Guinea-Bissau
|
|
|
- Liberia
|
|
|
- Mali
|
|
|
- Mauritania
|
|
|
- Niger
|
|
|
- Nigeria
|
|
|
- Saint Helena, Ascension and Tristan da Cunha
|
|
|
- Senegal
|
|
|
- Sierra Leone
|
|
|
- Togo
|
|
|
# Caribbean:
|
|
|
- Anguilla
|
|
|
- Antigua and Barbuda
|
|
|
- Aruba
|
|
|
- Bahamas
|
|
|
- Barbados
|
|
|
- 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
|
|
|
- Saint Lucia
|
|
|
- Saint Martin
|
|
|
- Saint Vincent and the Grenadines
|
|
|
- Sint Maarten
|
|
|
- Trinidad and Tobago
|
|
|
- Turks and Caicos Islands
|
|
|
- US Virgin Islands
|
|
|
# Central America:
|
|
|
- Belize
|
|
|
- Costa Rica
|
|
|
- El Salvador
|
|
|
- Guatemala
|
|
|
- Honduras
|
|
|
- Mexico
|
|
|
- Nicaragua
|
|
|
- Panama
|
|
|
# South America:
|
|
|
- Argentina
|
|
|
- Bolivia
|
|
|
- Bouvet Island
|
|
|
- Brazil
|
|
|
- Chile
|
|
|
- Colombia
|
|
|
- Ecuador
|
|
|
- Falkland Islands
|
|
|
- French Guiana
|
|
|
- Guyana
|
|
|
- Paraguay
|
|
|
- Peru
|
|
|
- South Georgia and the South Sandwich Islands
|
|
|
- Suriname
|
|
|
- Uruguay
|
|
|
- Venezuela
|
|
|
# North America:
|
|
|
- Bermuda
|
|
|
- Canada
|
|
|
- Greenland
|
|
|
- Saint Pierre and Miquelon
|
|
|
- United States
|
|
|
# Antarctica:
|
|
|
- Antarctica
|
|
|
# Central Asia:
|
|
|
- Kazakhstan
|
|
|
- Kyrgyzstan
|
|
|
- Tajikistan
|
|
|
- Turkmenistan
|
|
|
- Uzbekistan
|
|
|
# Eastern Asia:
|
|
|
- China
|
|
|
- Hong Kong
|
|
|
- Macao
|
|
|
- North Korea
|
|
|
- Japan
|
|
|
- Mongolia
|
|
|
- South Korea
|
|
|
- Taiwan
|
|
|
# South-Eastern Asia:
|
|
|
- Brunei
|
|
|
- Cambodia
|
|
|
- Indonesia
|
|
|
- Laos
|
|
|
- Malaysia
|
|
|
- Myanmar
|
|
|
- Philippines
|
|
|
- Singapore
|
|
|
- Thailand
|
|
|
- East Timor
|
|
|
- Vietnam
|
|
|
# Southern Asia:
|
|
|
- Afghanistan
|
|
|
- Bangladesh
|
|
|
- Bhutan
|
|
|
- India
|
|
|
- Iran
|
|
|
- Maldives
|
|
|
- Nepal
|
|
|
- Pakistan
|
|
|
- Sri Lanka
|
|
|
# Western Asia:
|
|
|
- Armenia
|
|
|
- Azerbaijan
|
|
|
- Bahrain
|
|
|
- Cyprus
|
|
|
- Georgia
|
|
|
- Iraq
|
|
|
- Israel
|
|
|
- Jordan
|
|
|
- Kuwait
|
|
|
- Lebanon
|
|
|
- Oman
|
|
|
- Qatar
|
|
|
- Saudi Arabia
|
|
|
- Palestine
|
|
|
- Syria
|
|
|
- Turkey
|
|
|
- United Arab Emirates
|
|
|
- Yemen
|
|
|
# Eastern Europe:
|
|
|
- Belarus
|
|
|
- Bulgaria
|
|
|
- Czech Republic
|
|
|
- Hungary
|
|
|
- Poland
|
|
|
- Moldova
|
|
|
- Romania
|
|
|
- Russia
|
|
|
- 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
|
|
|
- Sweden
|
|
|
- United Kingdom
|
|
|
# Southern Europe:
|
|
|
- Albania
|
|
|
- Andorra
|
|
|
- Bosnia and Herzegovina
|
|
|
- Croatia
|
|
|
- Gibraltar
|
|
|
- Greece
|
|
|
- Kosovo
|
|
|
- Vatican City
|
|
|
- Italy
|
|
|
- Malta
|
|
|
- Montenegro
|
|
|
- North Macedonia
|
|
|
- Portugal
|
|
|
- San Marino
|
|
|
- Serbia
|
|
|
- Serbia and Montenegro
|
|
|
- Slovenia
|
|
|
- Spain
|
|
|
- Yugoslavia
|
|
|
# Western Europe:
|
|
|
- Austria
|
|
|
- Belgium
|
|
|
- France
|
|
|
- Germany
|
|
|
- Liechtenstein
|
|
|
- Luxembourg
|
|
|
- Monaco
|
|
|
- Netherlands
|
|
|
- Switzerland
|
|
|
#Australia and New Zealand:
|
|
|
- Australia
|
|
|
- Christmas Island
|
|
|
- Cocos (Keeling) Islands
|
|
|
- Heard Island and McDonald Islands
|
|
|
- New Zealand
|
|
|
- Norfolk Island
|
|
|
# Melanesia:
|
|
|
- Fiji
|
|
|
- New Caledonia
|
|
|
- Papua New Guinea
|
|
|
- Solomon Islands
|
|
|
- Vanuatu
|
|
|
# Micronesia:
|
|
|
- Guam
|
|
|
- Kiribati
|
|
|
- Marshall Islands
|
|
|
- Micronesia
|
|
|
- Nauru
|
|
|
- Northern Mariana Islands
|
|
|
- Palau
|
|
|
- US Minor Outlying Islands
|
|
|
# Polynesia:
|
|
|
- American Samoa
|
|
|
- Cook Islands
|
|
|
- French Polynesia
|
|
|
- Niue
|
|
|
- Pitcairn Islands
|
|
|
- Samoa
|
|
|
- Tokelau
|
|
|
- Tonga
|
|
|
- Tuvalu
|
|
|
- Wallis and Futuna Islands
|
|
|
```
|
|
|
|
|
|
### Default `addons`
|
|
|
|
|
|
```yaml
|
|
|
addons:
|
|
|
Tanzania:
|
|
|
- United Republic of Tanzania
|
|
|
Republic of the Congo:
|
|
|
- Congo
|
|
|
Democratic Republic of the Congo:
|
|
|
- Zaire
|
|
|
São Tomé and Príncipe:
|
|
|
- Sao Tome and Principe
|
|
|
Eswatini:
|
|
|
- Swaziland
|
|
|
Cape Verde:
|
|
|
- Cabo Verde
|
|
|
Côte d'Ivoire:
|
|
|
- Côte d’Ivoire
|
|
|
- Ivory Coast
|
|
|
Saint Helena, Ascension and Tristan da Cunha:
|
|
|
- Saint Helena
|
|
|
- St. Helena
|
|
|
- Ascension
|
|
|
- Tristan da Cunha
|
|
|
Antigua and Barbuda:
|
|
|
- Antigua
|
|
|
- Barbuda
|
|
|
Bonaire, Sint Eustatius and Saba:
|
|
|
- Bonaire
|
|
|
- Sint Eustatius
|
|
|
- Saba
|
|
|
Saint Kitts and Nevis:
|
|
|
- St. Kitts and Nevis
|
|
|
Saint Lucia:
|
|
|
- St. Lucia
|
|
|
Saint Vincent and the Grenadines:
|
|
|
- Saint Vincent and Grenadines
|
|
|
- St. Vincent and the Grenadines
|
|
|
- St. Vincent and Grenadines
|
|
|
US Virgin Islands:
|
|
|
- U.S. Virgin Islands
|
|
|
- United States Virgin Islands
|
|
|
Bolivia:
|
|
|
- Plurinational State of Bolivia
|
|
|
Falkland Islands:
|
|
|
- Malvinas
|
|
|
South Georgia and the South Sandwich Islands:
|
|
|
- South Georgia and South Sandwich Islands
|
|
|
- South Georgia
|
|
|
- South Sandwich Islands
|
|
|
Venezuela:
|
|
|
- Bolivarian Republic of Venezuela
|
|
|
Saint Pierre and Miquelon:
|
|
|
- St. Pierre and Miquelon
|
|
|
United States:
|
|
|
- United States of America
|
|
|
Hong Kong:
|
|
|
- Hong Kong SAR China
|
|
|
Macao:
|
|
|
- Macau
|
|
|
- Macau SAR China
|
|
|
North Korea:
|
|
|
- Democratic People's Republic of Korea
|
|
|
South Korea:
|
|
|
- Republic of Korea
|
|
|
- Korea
|
|
|
Taiwan:
|
|
|
- Taiwan, Province of China
|
|
|
Brunei:
|
|
|
- Brunei Darussalam
|
|
|
Laos:
|
|
|
- Lao People's Democratic Republic
|
|
|
- Lao
|
|
|
Myanmar:
|
|
|
- Burma
|
|
|
East Timor:
|
|
|
- Timor-Leste
|
|
|
Vietnam:
|
|
|
- Viet Nam
|
|
|
Iran:
|
|
|
- Islamic Republic of Iran
|
|
|
Palestine:
|
|
|
- State of Palestine
|
|
|
Syria:
|
|
|
- Syrian Arab Republic
|
|
|
Turkey:
|
|
|
- Türkiye
|
|
|
Czech Republic:
|
|
|
- Czechia
|
|
|
- Czechoslovakia
|
|
|
Moldova:
|
|
|
- Republic of Moldova
|
|
|
Russia:
|
|
|
- Russian Federation
|
|
|
- Soviet Union
|
|
|
Svalbard and Jan Mayen Islands:
|
|
|
- Svalbard and Jan Mayen
|
|
|
Vatican City:
|
|
|
- Holy See
|
|
|
North Macedonia:
|
|
|
- Macedonia
|
|
|
- Republic of North Macedonia
|
|
|
France:
|
|
|
- French Republic
|
|
|
Germany:
|
|
|
- East Germany
|
|
|
Heard Island and McDonald Islands:
|
|
|
- Heard and McDonald Islands
|
|
|
Papua New Guinea:
|
|
|
- New Guinea
|
|
|
Micronesia:
|
|
|
- Federated States of Micronesia
|
|
|
US Minor Outlying Islands:
|
|
|
- United States Minor Outlying Islands
|
|
|
- United States Outlying Islands
|
|
|
- U.S. Minor Outlying Islands
|
|
|
- U.S. Outlying Islands
|
|
|
- US Outlying Islands
|
|
|
Pitcairn Islands:
|
|
|
- Pitcairn
|
|
|
Wallis and Futuna Islands:
|
|
|
- Wallis and Futuna
|
|
|
```
|
