By default, the collections generated will be named for the thing being used to create them; things like genres, countries, actors or even Trakt List Names.
There are many attributes that can change the titles, including `title_format`, `remove_suffix`, `remove_prefix`, `pre_format_override`, and `post_format_override` all detailed below.
There are many attributes that can change the titles, including `title_format`, `remove_suffix`, `remove_prefix`, `key_name_override`, and `title_override` all detailed below.
## Dynamic Keys & Key Names
@ -52,7 +52,7 @@ dynamic_collections:
- Horror
```
* Using the `pre_format_override` attribute to change the formatting of "France" to "French" so that a collection can be named "French Cinema" instead of simply "France"
* Using the `key_name_override` attribute to change the formatting of "France" to "French" so that a collection can be named "French Cinema" instead of simply "France"
* This particular example also uses the `title_format` attribute to manipulate the naming convention of the collections.
```yaml
@ -60,7 +60,7 @@ dynamic_collections:
Countries: # mapping name does not matter, just needs to be unique
| [`type`](#type--data) | Type of Dynamic Collection to be created. | ✅ |
| [`data`](#type--data) | Data to determine how dynamic collections with a certain `type` are created. | Depends on `type` |
| [`exclude`](#exclude) | Exclude this list of keys from being created into collections. | ❌ |
| [`addons`](#addons) | Defines how multiple keys can be combined under a parent key. | ❌ |
| [`template`](#template) | Name of the template to use for these dynamic collections. | ❌ |
| [`template_variables`](#template-variables) | Defines how template variables can be defined by key. | ❌ |
| [`remove_suffix`](#remove-prefixsuffix) | Removes the defined suffixes from the key before it's used in the collection title. | ❌ |
| [`remove_prefix`](#remove-prefixsuffix) | Removes the defined prefixes from the key before it's used in the collection title. | ❌ |
| [`title_format`](#title-format) | This is the format for the collection titles. | ❌ |
| [`pre_format_override`](#pre-format-override) | Defines how titles can be overridden before they are formatted into collection titles. | ❌ |
| [`post_format_override`](#post-format-override) | Defines how collection titles can be overridden ignoring title formatting. | ❌ |
| [`test`](#test) | Will add `test: true` to all collections for test runs. | ❌ |
| [`sync`](#sync) | Will remove dynamic collections that are no longer in the creation list. | ❌ |
| [`include`](#include) | Define a list of keys to be made into collections. | ❌ |
| [`other_name`](#other-name) | Used in combination with `include`. When defined, all keys not in `include` or `addons` will be combined into this collection. | ❌ |
| [`type`](#type--data) | Type of Dynamic Collection to be created. | ✅ |
| [`data`](#type--data) | Data to determine how dynamic collections with a certain `type` are created. | Depends on `type` |
| [`exclude`](#exclude) | Exclude this list of keys from being created into collections. | ❌ |
| [`addons`](#addons) | Defines how multiple keys can be combined under a parent key. | ❌ |
| [`template`](#template) | Name of the template to use for these dynamic collections. | ❌ |
| [`template_variables`](#template-variables) | Defines how template variables can be defined by key. | ❌ |
| [`remove_suffix`](#remove-prefixsuffix) | Removes the defined suffixes from the key before it's used in the collection title. | ❌ |
| [`remove_prefix`](#remove-prefixsuffix) | Removes the defined prefixes from the key before it's used in the collection title. | ❌ |
| [`title_format`](#title-format) | This is the format for the collection titles. | ❌ |
| [`key_name_override`](#key-name-override) | Defines how key names can be overridden before they are formatted into collection titles. | ❌ |
| [`title_override`](#title-override) | Defines how collection titles can be overridden ignoring title formatting. | ❌ |
| [`test`](#test) | Will add `test: true` to all collections for test runs. | ❌ |
| [`sync`](#sync) | Will remove dynamic collections that are no longer in the creation list. | ❌ |
| [`include`](#include) | Define a list of keys to be made into collections. | ❌ |
| [`other_name`](#other-name) | Used in combination with `include`. When defined, all keys not in `include` or `addons` will be combined into this collection. | ❌ |
## Type & Data
@ -110,6 +110,7 @@ Depending on the `type` of dynamic collection, `data` is used to specify the opt
| [`tmdb_collection`](#tmdb-collection) | Create a collection for each TMDb Collection associated with an item in the library | ❌ | ✅ | ❌ | ❌ | ❌ |
| [`tmdb_popular_people`](#tmdb-popular-people) | Create a collection for each actor found on [TMDb's Popular People List](https://www.themoviedb.org/person) | ✅ | ✅ | ✅ | ❌ | ❌ |
| [`original_language`](#original-language) | Create a collection for each TMDb original language associated with an item in the library | ❌ | ✅ | ✅ | ❌ | ❌ |
| [`origin_country`](#origin-country) | Create a collection for each TMDb origin country associated with an item in the library | ❌ | ❌ | ✅ | ❌ | ❌ |
| [`trakt_user_lists`](#trakt-user-lists) | Create a collection for each list from specific trakt users | ✅ | ✅ | ✅ | ❌ | ❌ |
| [`trakt_liked_lists`](#trakt-liked-lists) | Create a collection for each list the authenticated trakt user likes | ❌ | ✅ | ✅ | ❌ | ❌ |
| [`trakt_people_list`](#trakt-people-lists) | Create a collection for each actor found in the trakt list | ✅ | ✅ | ✅ | ❌ | ❌ |
@ -143,7 +144,7 @@ Create collections based on the TMDb Collections associated with items in the li
<td>TMDb Collection ID</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>TMDb Collection Title</td>
</tr>
<tr>
@ -191,7 +192,7 @@ Create collections based on each actor found on [TMDb's Popular People List](htt
<td>TMDb Person ID</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>TMDb Person Name</td>
</tr>
<tr>
@ -241,7 +242,7 @@ Create collections based on the TMDb original language associated with items in
#### Example: Create collection for every TMDb Origin Country found in the library.
```yaml
dynamic_collections:
TMDb Countries: # This name is the mapping name
type: origin_country
```
### Trakt User Lists
@ -292,7 +340,7 @@ Create collections for each of the Trakt lists for the specified users. Use `me`
<td>Trakt List URL</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>Trakt List Title</td>
</tr>
<tr>
@ -343,7 +391,7 @@ Create collections for each of the Trakt lists that the authenticated user has l
<td>Trakt List URL</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>Trakt List Title</td>
</tr>
<tr>
@ -391,7 +439,7 @@ Create collections for each of the people found within Trakt lists that the user
<td>TMDb Person ID</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>TMDb Person Name</td>
</tr>
<tr>
@ -463,7 +511,7 @@ Create a collection for each actor found in the library.
<td>TMDb Person ID</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>TMDb Person Name</td>
</tr>
<tr>
@ -490,6 +538,33 @@ default_template:
* `minimum` determines the minimum number of times the actor must appear within `depth` for the collection to be created.
* `limit` determines the number of actor collection to max out at. (i.e. if to make collections for the top 25 actors)
#### Example:
* Create a collection for the top 25 actors who appear in the top 5 billing credits of movies
```yaml
dynamic_collections:
Top Actors: # mapping name does not matter just needs to be unique
type: actor
data:
depth: 5
limit: 25
```
#### Example:
* Create a collection for actors who appear in the top 5 billing credits of movies
* Only create the collection if they are in the top 5 billing credits of at least 20 movies
```yaml
dynamic_collections:
Actors: # mapping name does not matter just needs to be unique
type: actor
data:
depth: 5
minimum: 20
```
### Director
Create a collection for each director found in the library.
@ -530,7 +605,7 @@ Create a collection for each director found in the library.
<td>TMDb Person ID</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>TMDb Person Name</td>
</tr>
<tr>
@ -557,6 +632,33 @@ default_template:
* `minimum` determines the minimum number of times the director must appear within `depth` for the collection to be created.
* `limit` determines the number of director collection to max out at. (i.e. if to make collections for the top 25 directors)
#### Example:
* Create a collection for the top 5 directors who appear in the top director credit of movies
```yaml
dynamic_collections:
Top Directors: # mapping name does not matter just needs to be unique
type: director
data:
depth: 1
limit: 5
```
#### Example:
* Create a collection for directors who appear in the top director credits of movies
* Only create the collection if they are in the top director credits of at least 10 movies
```yaml
dynamic_collections:
Directors: # mapping name does not matter just needs to be unique
type: director
data:
depth: 1
minimum: 10
```
### Writer
Create a collection for each writer found in the library.
@ -597,7 +699,7 @@ Create a collection for each writer found in the library.
<td>TMDb Person ID</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>TMDb Person Name</td>
</tr>
<tr>
@ -624,6 +726,33 @@ default_template:
* `minimum` determines the minimum number of times the writer must appear within `depth` for the collection to be created.
* `limit` determines the number of writer collection to max out at. (i.e. if to make collections for the top 25 writers)
#### Example:
* Create a collection for the top 5 writers who appear in the top writer credit of movies
```yaml
dynamic_collections:
Top Writers: # mapping name does not matter just needs to be unique
type: writer
data:
depth: 1
limit: 5
```
#### Example:
* Create a collection for writers who appear in the top writer credits of movies
* Only create the collection if they are in the top writer credits of at least 10 movies
```yaml
dynamic_collections:
Writers: # mapping name does not matter just needs to be unique
type: writer
data:
depth: 1
minimum: 10
```
### Producer
Create a collection for each producer found in the library.
@ -664,7 +793,7 @@ Create a collection for each producer found in the library.
<td>TMDb Person ID</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>TMDb Person Name</td>
</tr>
<tr>
@ -693,29 +822,29 @@ default_template:
#### Example:
* Create a collection for the top 25 actors who appear in the top 5 billing credits of movies
* Create a collection for the top 5 producers who appear in the top producer credit of movies
```yaml
dynamic_collections:
Top Actors: # mapping name does not matter just needs to be unique
type: actor
Top Producers: # mapping name does not matter just needs to be unique
type: producer
data:
depth: 5
limit: 25
depth: 1
limit: 5
```
#### Example:
* Create a collection for actors who appear in the top 5 billing credits of movies
* Only create the collection if they are in the top 5 billing credits of at least 20 movies
* Create a collection for producers who appear in the top producer credits of movies
* Only create the collection if they are in the top producer credits of at least 10 movies
```yaml
dynamic_collections:
Actors: # mapping name does not matter just needs to be unique
type: actor
Producers: # mapping name does not matter just needs to be unique
type: producers
data:
depth: 5
minimum: 20
depth: 1
minimum: 10
```
### Genre
@ -736,7 +865,7 @@ Create a collection for each genre found in the library.
<td>Genre</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>Genre</td>
</tr>
<tr>
@ -802,7 +931,7 @@ Create a collection for each year found in the library.
<td>Year</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>Year</td>
</tr>
<tr>
@ -861,7 +990,7 @@ Create a collection for each decade found in the library
<td>Decade</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>Decade</td>
</tr>
<tr>
@ -896,7 +1025,7 @@ dynamic_collections:
Decades: # mapping name does not matter just needs to be unique
type: decade
title_format: Top <<key_name>> <<library_type>>s
post_format_override:
title_override:
2020: Top 2020 Movies (so far)
```
@ -918,7 +1047,7 @@ Create a collection for each country found in the library
<td>Country</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>Country</td>
</tr>
<tr>
@ -946,14 +1075,14 @@ default_template:
* Create a collection for the top movies from each country found in the library
* Name the collection Top [Country] Cinema
* The `pre_format_override` attribute is used here in combination with the `title_format` to change the collection name from "France" which would be the default title, to "Top French Cinema"
* The `key_name_override` attribute is used here in combination with the `title_format` to change the collection name from "France" which would be the default title, to "Top French Cinema"
```yaml
dynamic_collections:
Countries: # mapping name does not matter just needs to be unique
type: country
title_format: Top <<key_name>> Cinema
pre_format_override:
key_name_override:
France: French
Germany: German
India: Indian
@ -977,7 +1106,7 @@ Create a collection for each network found in the library.
<td>Network</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>Network</td>
</tr>
<tr>
@ -1038,7 +1167,7 @@ Create a collection for each mood found in the library.
<td>Mood</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>Mood</td>
</tr>
<tr>
@ -1101,7 +1230,7 @@ Create a collection for each style found in the library.
<td>Style</td>
</tr>
<tr>
<th>Titles</th>
<th>Key Names</th>
<td>Style</td>
</tr>
<tr>
@ -1252,11 +1381,11 @@ dynamic_collections:
title_format: Top 50 <<key_name>> <<library_type>>s
```
## Pre Format Override
## Key Name Override
Defines how titles can be overridden before they are formatted into collection titles.
Defines how key names can be overridden before they are formatted into collection titles.
This example uses the `pre_format_override` attribute to change the formatting of "France" to "French" so that a collection can be named "French Cinema" instead of simply "France"
This example uses the `key_name_override` attribute to change the formatting of "France" to "French" so that a collection can be named "French Cinema" instead of simply "France"
* This particular example also uses the `title_format` attribute to manipulate the naming convention of the collections.
```yaml
@ -1264,22 +1393,22 @@ dynamic_collections:
Countries: # mapping name does not matter, just needs to be unique
type: country
title_format: <<key_name>> Cinema
pre_format_override:
key_name_override:
France: French
```
## Post Format Override
## Title Override
Defines how collection titles can be overridden ignoring title formatting.
Here's an example using `post_format_override` that will override the TMDb Star Wars collection which has an TMDb ID of `10` with `Star Wars Universe.
Here's an example using `title_override` that will override the TMDb Star Wars collection which has an TMDb ID of `10` with `Star Wars Universe.
```yaml
dynamic_collections:
TMDb Collections: # mapping name does not matter, just needs to be unique
meisnate12
3 years ago