meisnate12
2 years ago
parent
b610e4aa59
commit
fdf3494227
@ -0,0 +1,72 @@
|
||||
# Seasonal Collections
|
||||
|
||||
The `seasonal` Default Metadata File is used to dynamically create seasonal collections based on holidays .
|
||||
|
||||
**This file only works with Movie Libraries.**
|
||||
|
||||
|
||||
|
||||
## Collections Section 00
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:-----------------------------|:--------------:|:-----------------------------------------------------------|
|
||||
| `Seasonal Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `🎊 New Year's Day Movies` | `years` | Collection of Movies related to New Year's Day. |
|
||||
| `💘 Valentine's Day Movies` | `valentine` | Collection of Movies related to Valentine's Day. |
|
||||
| `☘ St. Patrick's Day Movies` | `patrick` | Collection of Movies related to St. Patrick's Day. |
|
||||
| `🐰 Easter Movies` | `easter` | Collection of Movies related to Easter. |
|
||||
| `🤱 Mother's Day Movies` | `mother` | Collection of Movies related to Mother's Day. |
|
||||
| `🪖 Memorial Day Movies` | `memorial` | Collection of Movies related to Memorial Day. |
|
||||
| `👨 Father's Day Movies` | `father` | Collection of Movies related to Father's Day. |
|
||||
| `🎆 Independence Day Movies` | `independence` | Collection of Movies related to Independence Day. |
|
||||
| `⚒ Labor Day Movies` | `labor` | Collection of Movies related to Labor Day. |
|
||||
| `🎃 Halloween Movies` | `halloween` | Collection of Movies related to Halloween. |
|
||||
| `🦃 Thanksgiving Movies` | `thanksgiving` | Collection of Movies related to Thanksgiving. |
|
||||
| `🎅 Christmas Movies` | `christmas` | Collection of Movies related to Christmas. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: seasonal
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `true` to turn on the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 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>>` | **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) |
|
||||
| `schedule_<<key>>` | **Description:** Changes the Schedule of the specified key's Collection.<br>**Default:**<table class="clearTable"><tr><td><code>🎊 New Year's Day Movies</code></td><td>range(12/26-01/04)</td></tr><tr><td><code>💘 Valentine's Day Movies</code></td><td>range(02/01-02/29)</td></tr><tr><td><code>☘ St. Patrick's Day Movies</code></td><td>range(03/01-03/18)</td></tr><tr><td><code>🐰 Easter Movies</code></td><td>range(03/20-04/30)</td></tr><tr><td><code>🤱 Mother's Day Movies</code></td><td>range(05/05-05/10)</td></tr><tr><td><code>🪖 Memorial Day Movies</code></td><td>range(5/18-6/7)</td></tr><tr><td><code>👨 Father's Day Movies</code></td><td>range(06/15-06/20)</td></tr><tr><td><code>🎆 Independence Day Movies</code></td><td>range(06/23-07/11)</td></tr><tr><td><code>⚒ Labor Day Movies</code></td><td>range(09/01-09/10)</td></tr><tr><td><code>🎃 Halloween Movies</code></td><td>range(10/01-10/31)</td></tr><tr><td><code>🦃 Thanksgiving Movies</code></td><td>range(11/01-11/30)</td></tr><tr><td><code>🎅 Christmas Movies</code></td><td>range(12/01-12/31)</td></tr></table><br>**Values:** [Any Schedule Option](../../metadata/details/schedule) |
|
||||
| `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.<br>**Values:** List of Seasons Keys |
|
||||
| `seasonal_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `seasonal_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `A collection of <<key_name>> <<library_translation>>s that may relate to the season.`<br>**Values:** Any string. |
|
||||
|
||||
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: seasonal
|
||||
template_variables:
|
||||
use_separator: true
|
||||
sep_style: stb
|
||||
use_independence: false
|
||||
schedule_thanksgiving: range(10/01-10/30)
|
||||
sort_by: random
|
||||
```
|
||||
@ -0,0 +1,139 @@
|
||||
# US Content Rating Collections
|
||||
|
||||
The `content_rating_us` Default Metadata File is used to dynamically create collections based on the content ratings available in your library.
|
||||
|
||||
If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
|
||||
|
||||
**This file works with TV Libraries, but has a Movie Library [Counterpart](../movie/content_rating_us).**
|
||||
|
||||
|
||||
|
||||
## Collections Section 14
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:---------------------------------------------------------|:--------------------------------------------:|:-------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Shows`<br>**Example:** `TV-14 Shows` | `<<Content Rating>>`<br>**Example:** `TV-14` | Collection of Shows that have this Content Rating. |
|
||||
| `Not Rated Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: content_rating_us
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 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>>` | **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 Content Ratings found in your library |
|
||||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings 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 Content Ratings found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
||||
| `content_rating_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `content_rating_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Not Rated <<library_translationU>>s`<br>**Values:** Any string. |
|
||||
| `content_rating_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `content_rating_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`<br>**Values:** Any string. |
|
||||
|
||||
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: content_rating_us
|
||||
template_variables:
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: blue
|
||||
append_addons:
|
||||
R:
|
||||
- "de/18"
|
||||
sort_by: title.asc
|
||||
```
|
||||
|
||||
## Default `include`
|
||||
|
||||
```yaml
|
||||
include:
|
||||
- TV-G
|
||||
- TV-Y
|
||||
- TV-PG
|
||||
- TV-14
|
||||
- TV-MA
|
||||
```
|
||||
|
||||
## Default `addons`
|
||||
|
||||
```yaml
|
||||
addons:
|
||||
TV-G:
|
||||
- gb/U
|
||||
- gb/0+
|
||||
- U
|
||||
- G
|
||||
- 1
|
||||
- 2
|
||||
- 3
|
||||
- 4
|
||||
- 5
|
||||
- 6
|
||||
- "01"
|
||||
- "02"
|
||||
- "03"
|
||||
- "04"
|
||||
- "05"
|
||||
- "06"
|
||||
TV-Y:
|
||||
- TV-Y7
|
||||
- TV-Y7-FV
|
||||
- 7
|
||||
- 8
|
||||
- 9
|
||||
- "07"
|
||||
- "08"
|
||||
- "09"
|
||||
TV-PG:
|
||||
- gb/PG
|
||||
- gb/9+
|
||||
- 10
|
||||
- 11
|
||||
- 12
|
||||
- 13
|
||||
TV-14:
|
||||
- gb/12A
|
||||
- 12+
|
||||
- PG-13
|
||||
- TV-13
|
||||
- gb/14+
|
||||
- gb/15
|
||||
- 14
|
||||
- 15
|
||||
- 16
|
||||
- 17
|
||||
TV-MA:
|
||||
- 18
|
||||
- gb/18
|
||||
- MA-17
|
||||
- NC-17
|
||||
- R
|
||||
- TVMA
|
||||
```
|
||||
@ -1,54 +1,317 @@
|
||||
# Country Default Metadata File
|
||||
# Country Collections
|
||||
|
||||
The `show/country` Metadata File is used to dynamically create collections based on the countries available in your library.
|
||||
The `country` Default Metadata File is used to dynamically create collections based on the countries available in your library.
|
||||
|
||||
Example Collections Created:
|
||||
**This file works with TV Libraries, but has a Movie Library [Counterpart](../movie/content_rating_us).**
|
||||
|
||||
|
||||
|
||||
## Collections Section 09
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:----------------------------------------|:--------------------------------------------------:|:-------------------------------------------------------------|
|
||||
| `Country Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `<<Country>>`<br>**Example:** `Germany` | `<<2 digit ISO 3166-1 code>>`<br>**Example:** `de` | Collection of TV Shows that have this Country. |
|
||||
| `Other Countries` | `other` | Collection of TV Shows that are in other uncommon Countries. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: show/country
|
||||
- pmm: country
|
||||
```
|
||||
|
||||
## Color Style
|
||||
Below is a screenshot of the alternative `color` style which can be set via template variables
|
||||
|
||||
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 from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
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.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `addons` | **Description:** Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
| Variable | Description & Values |
|
||||
|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `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 then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 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>>` | **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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||
| `addons` | **Description:** 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 [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) |
|
||||
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).`key_name` by `key` |
|
||||
| `country_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `country_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Other Countries`<br>**Values:** Any string. |
|
||||
| `country_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
||||
| `country_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s filmed in other uncommon Countries.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: country
|
||||
template_variables:
|
||||
exclude:
|
||||
- fr
|
||||
sort_by: title.asc
|
||||
collection_section: 8
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
exclude:
|
||||
- fr
|
||||
sort_by: title.asc
|
||||
```
|
||||
|
||||
## Default `include`
|
||||
|
||||
```yaml
|
||||
include:
|
||||
# - af # Afghanistan
|
||||
# - ax # Åland Islands
|
||||
# - al # Albania
|
||||
# - dz # Algeria
|
||||
# - ad # Andorra
|
||||
# - ao # Angola
|
||||
# - ai # Anguilla
|
||||
# - aq # Antarctica
|
||||
# - ag # Antigua
|
||||
- ar # Argentina
|
||||
# - am # Armenia
|
||||
# - aw # Aruba
|
||||
- au # Australia
|
||||
- at # Austria
|
||||
# - az # Azerbaijan
|
||||
- bs # Bahamas
|
||||
# - bh # Bahrain
|
||||
# - bd # Bangladesh
|
||||
# - bb # Barbados
|
||||
# - by # Belarus
|
||||
- be # Belgium
|
||||
# - bz # Belize
|
||||
# - bj # Benin
|
||||
# - bm # Bermuda
|
||||
# - bt # Bhutan
|
||||
# - bo # Bolivia
|
||||
# - bq # Bonaire
|
||||
# - ba # Bosnia and Herzegovina
|
||||
# - bw # Botswana
|
||||
# - bv # Bouvet Island
|
||||
- br # Brazil
|
||||
# - bn # Brunei
|
||||
- bg # Bulgaria
|
||||
# - bf # Burkina Faso
|
||||
# - bi # Burundi
|
||||
# - cv # Cabo Verde
|
||||
# - kh # Cambodia
|
||||
# - cm # Cameroon
|
||||
- ca # Canada
|
||||
# - ky # Cayman Islands
|
||||
# - cf # Central African Republic
|
||||
# - td # Chad
|
||||
- cl # Chile
|
||||
- cn # China
|
||||
# - cx # Christmas Island
|
||||
# - cc # Cocos (Keeling) Islands
|
||||
# - co # Colombia
|
||||
# - km # Comoros
|
||||
# - cg # Congo
|
||||
# - ck # Cook Islands
|
||||
- cr # Costa Rica
|
||||
# - ci # Côte d'Ivoire
|
||||
- hr # Croatia
|
||||
# - cu # Cuba
|
||||
# - cw # Curaçao
|
||||
# - cy # Cyprus
|
||||
- cz # Czech Republic
|
||||
- dk # Denmark
|
||||
# - dj # Djibouti
|
||||
# - dm # Dominica
|
||||
- do # Dominican Republic
|
||||
# - ec # Ecuador
|
||||
- eg # Egypt
|
||||
# - sv # El Salvador
|
||||
# - gq # Equatorial Guinea
|
||||
# - er # Eritrea
|
||||
- ee # Estonia
|
||||
# - sz # Eswatini
|
||||
# - et # Ethiopia
|
||||
# - fk # Falkland Islands
|
||||
# - fo # Faroe Islands
|
||||
# - fj # Fiji
|
||||
- fi # Finland
|
||||
- fr # France
|
||||
# - gf # French Guiana
|
||||
# - pf # French Polynesia
|
||||
# - ga # Gabon
|
||||
# - gm # Gambia
|
||||
# - ge # Georgia
|
||||
- de # Germany
|
||||
# - gh # Ghana
|
||||
# - gi # Gibraltar
|
||||
- gr # Greece
|
||||
# - gl # Greenland
|
||||
# - gd # Grenada
|
||||
# - gp # Guadeloupe
|
||||
# - gu # Guam
|
||||
# - gt # Guatemala
|
||||
# - gg # Guernsey
|
||||
# - gn # Guinea
|
||||
# - gw # Guinea-Bissau
|
||||
# - gy # Guyana
|
||||
# - ht # Haiti
|
||||
# - va # Holy See
|
||||
# - hn # Honduras
|
||||
- hk # Hong Kong
|
||||
- hu # Hungary
|
||||
- is # Iceland
|
||||
- in # India
|
||||
- id # Indonesia
|
||||
- ir # Iran
|
||||
# - iq # Iraq
|
||||
- ie # Ireland
|
||||
# - im # Isle of Man
|
||||
- il # Israel
|
||||
- it # Italy
|
||||
# - jm # Jamaica
|
||||
- jp # Japan
|
||||
# - je # Jersey
|
||||
# - jo # Jordan
|
||||
# - kz # Kazakhstan
|
||||
# - ke # Kenya
|
||||
# - ki # Kiribati
|
||||
- kr # Korea
|
||||
# - kw # Kuwait
|
||||
# - kg # Kyrgyzstan
|
||||
# - la # Lao
|
||||
- lv # Latvia
|
||||
# - lb # Lebanon
|
||||
# - ls # Lesotho
|
||||
# - lr # Liberia
|
||||
# - ly # Libya
|
||||
# - li # Liechtenstein
|
||||
# - lt # Lithuania
|
||||
- lu # Luxembourg
|
||||
# - mo # Macao
|
||||
# - mg # Madagascar
|
||||
# - mw # Malawi
|
||||
- my # Malaysia
|
||||
# - mv # Maldives
|
||||
# - ml # Mali
|
||||
# - mt # Malta
|
||||
# - mh # Marshall Islands
|
||||
# - mq # Martinique
|
||||
# - mr # Mauritania
|
||||
# - mu # Mauritius
|
||||
# - yt # Mayotte
|
||||
- mx # Mexico
|
||||
# - fm # Micronesia
|
||||
# - md # Moldova
|
||||
# - mc # Monaco
|
||||
# - mn # Mongolia
|
||||
# - me # Montenegro
|
||||
# - ms # Montserrat
|
||||
- ma # Morocco
|
||||
# - mz # Mozambique
|
||||
# - mm # Myanmar
|
||||
# - na # Namibia
|
||||
# - nr # Nauru
|
||||
# - np # Nepal
|
||||
- nl # Netherlands
|
||||
# - nc # New Caledonia
|
||||
- nz # New Zealand
|
||||
# - ni # Nicaragua
|
||||
# - ne # Niger
|
||||
# - ng # Nigeria
|
||||
# - nu # Niue
|
||||
# - nf # Norfolk Island
|
||||
# - mk # Macedonia
|
||||
- no # Norway
|
||||
# - om # Oman
|
||||
- pk # Pakistan
|
||||
# - pw # Palau
|
||||
# - ps # Palestine
|
||||
- pa # Panama
|
||||
# - pg # New Guinea
|
||||
# - py # Paraguay
|
||||
- pe # Peru
|
||||
- ph # Philippines
|
||||
# - pn # Pitcairn
|
||||
- pl # Poland
|
||||
- pt # Portugal
|
||||
# - pr # Puerto Rico
|
||||
- qa # Qatar
|
||||
# - re # Réunion
|
||||
- ro # Romania
|
||||
- ru # Russia
|
||||
# - rw # Rwanda
|
||||
# - bl # Saint Barthélemy
|
||||
# - lc # Saint Lucia
|
||||
# - ws # Samoa
|
||||
# - sm # San Marino
|
||||
# - st # Sao Tome and Principe
|
||||
- sa # Saudi Arabia
|
||||
# - sn # Senegal
|
||||
- rs # Serbia
|
||||
# - sc # Seychelles
|
||||
# - sl # Sierra Leone
|
||||
- sg # Singapore
|
||||
# - sk # Slovakia
|
||||
# - si # Slovenia
|
||||
# - sb # Solomon Islands
|
||||
# - so # Somalia
|
||||
- za # South Africa
|
||||
# - ss # South Sudan
|
||||
- es # Spain
|
||||
- lk # Sri Lanka
|
||||
# - sd # Sudan
|
||||
# - sr # Suriname
|
||||
- se # Sweden
|
||||
- ch # Switzerland
|
||||
# - sy # Syria
|
||||
# - tw # Taiwan
|
||||
# - tj # Tajikistan
|
||||
# - tz # Tanzania
|
||||
- th # Thailand
|
||||
# - tl # Timor-Leste
|
||||
# - tg # Togo
|
||||
# - tk # Tokelau
|
||||
# - to # Tonga
|
||||
# - tt # Trinidad and Tobago
|
||||
# - tn # Tunisia
|
||||
- tr # Turkey
|
||||
# - tm # Turkmenistan
|
||||
# - tc # Turks and Caicos
|
||||
# - tv # Tuvalu
|
||||
# - ug # Uganda
|
||||
- ua # Ukraine
|
||||
- ae # United Arab Emirates
|
||||
- gb # United Kingdom
|
||||
- us # United States of America
|
||||
# - uy # Uruguay
|
||||
# - uz # Uzbekistan
|
||||
# - vu # Vanuatu
|
||||
# - ve # Venezuela
|
||||
- vn # Vietnam
|
||||
# - ye # Yemen
|
||||
# - zm # Zambia
|
||||
# - zw # Zimbabwe
|
||||
```
|
||||
|
||||
## Default `key_name_override`
|
||||
|
||||
```yaml
|
||||
key_name_override:
|
||||
kr: Korea
|
||||
```
|
||||
@ -1,43 +1,59 @@
|
||||
# Decade Default Metadata File
|
||||
# Decade Collections
|
||||
|
||||
The `show/decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
|
||||
The `decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
|
||||
|
||||
Example Collections Created:
|
||||
**This file works with TV Libraries, but has a Movie Library [Counterpart](../movie/decade).**
|
||||
|
||||
|
||||
|
||||
## Collections Section 12
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:-----------------------------------------------------|:---------------------------------:|:-----------------------------------------------------------|
|
||||
| `Decade Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `Best of <<Decade>>`<br>**Example:** `Best of 2020s` | `<<Year>>`<br>**Example:** `2020` | Collection of Shows released in this Decade. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: show/decade
|
||||
```
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
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.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| Variable | Description & Values |
|
||||
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's Collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `critic_rating.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>` | **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) |
|
||||
| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.<br>**Values:** List of Decades found in your library |
|
||||
| `decade_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Best of <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `decade_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Top <<limit>> <<library_translation>>s of the <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: show/decade
|
||||
- pmm: decade
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 18
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
sort_by: title.asc
|
||||
```
|
||||
Loading…
Reference in new issue