diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 3c106396..8ee8fae5 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -32,11 +32,11 @@ Note that the `templates_variables:` section only needs to be used if you do wan 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_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the Collection Order
**Values:**
AttributeDescription & Values
startingValues: Number greater than 0Default: 0
endingValues: Number greater than 1Default: 1
incrementValues: Number greater than 0Default: 1
| +| Variable | Description & Values | +|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the values of the collections
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
| The below shows an example config.yml with all the template_variables set away from their defaults: diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index 9fba7e7c..c6dfdefe 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -17,24 +17,20 @@ libraries: ``` + ## 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 from the default settings which are provided. -Below are the available variables which can be used to customize the file. +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 just ignored. +All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Usage | Default Value | Values | -|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` | -| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` | -| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` | -| radarr_folder | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | +| Variable | Description & Values | +|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the values of the collections
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
| The below shows an example config.yml with all the template_variables set away from their defaults: @@ -44,12 +40,8 @@ libraries: metadata_path: - pmm: cannes template_variables: - collection_section: 9 + collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> ``` - diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index eb7bc95d..5102f4b6 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -18,28 +18,18 @@ libraries: ## 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. -Below are the available variables which can be used to customize the file. +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 want to actually change how the defaults work. Any value not specified is just ignored. -| Variable | Usage | Default Value | Values | -|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` | -| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` | -| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` | -| radarr_folder | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | -| sonarr_add_missing | Adds missing from the collection to Sonarr | `false` | `true` or `false` | -| sonarr_folder | Sonarr Folder to add to | | Folder to add missing items to | -| sonrr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items | +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_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the values of the collections
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
| The below shows an example config.yml with all the template_variables set away from their defaults: @@ -49,16 +39,10 @@ libraries: metadata_path: - pmm: choice template_variables: - collection_section: 9 + collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> - sonarr_add_missing: true - sonarr_folder: /mnt/local/Media/TV - sonarr_tag: <> - item_sonarr_tag: <> ``` + diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index 3a8045fd..86d41cac 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -16,29 +16,18 @@ libraries: ## 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. -Below are the available variables which can be used to customize the file. +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 want to actually change how the defaults work. Any value not specified is just ignored. -| Variable | Usage | Default Value | Values | -|:---------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |0 -| imdb_sort | Sets the sort of the IMDb Search | `moviemeter,desc ` | Any IMDb Search Sort Option |0 -| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` | -| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` | -| radarr_folder | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | -| sonarr_add_missing | Adds missing from the collection to Sonarr | `false` | `true` or `false` | -| sonarr_folder | Sonarr Folder to add to | | Folder to add missing items to | -| sonrr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items | +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_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the values of the collections
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| The below shows an example config.yml with all the template_variables set away from their defaults: @@ -48,17 +37,10 @@ libraries: metadata_path: - pmm: emmy template_variables: - collection_section: 9 + collection_section: 8 collection_mode: show_items collection_order: alpha - imdb_sort: moviemeter,asc radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> - sonarr_add_missing: true - sonarr_folder: /mnt/local/Media/TV - sonarr_tag: <> - item_sonarr_tag: <> ``` + diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index ced998b7..4e836923 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -16,29 +16,18 @@ libraries: ## 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. -Below are the available variables which can be used to customize the file. +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 want to actually change how the defaults work. Any value not specified is just ignored. -| Variable | Usage | Default Value | Values | -|:---------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |0 -| imdb_sort | Sets the sort of the IMDb Search | `moviemeter,desc ` | Any IMDb Search Sort Option |0 -| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` | -| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` | -| radarr_folder | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | -| sonarr_add_missing | Adds missing from the collection to Sonarr | `false` | `true` or `false` | -| sonarr_folder | Sonarr Folder to add to | | Folder to add missing items to | -| sonrr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items | +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_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the values of the collections
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| The below shows an example config.yml with all the template_variables set away from their defaults: @@ -48,17 +37,10 @@ libraries: metadata_path: - pmm: golden template_variables: - collection_section: 9 + collection_section: 8 collection_mode: show_items collection_order: alpha - imdb_sort: moviemeter,asc radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> - sonarr_add_missing: true - sonarr_folder: /mnt/local/Media/TV - sonarr_tag: <> - item_sonarr_tag: <> ``` + diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index 7ea0a997..55274c92 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -16,24 +16,18 @@ libraries: ## 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 from the default settings which are provided. -Below are the available variables which can be used to customize the file. +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 just ignored. +All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Usage | Default Value | Values | -|:---------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |0 -| imdb_sort | Sets the sort of the IMDb Search | `moviemeter,desc ` | Any IMDb Search Sort Option |0 -| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` | -| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` | -| radarr_folder | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | +| Variable | Description & Values | +|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the values of the collections
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| The below shows an example config.yml with all the template_variables set away from their defaults: @@ -43,13 +37,10 @@ libraries: metadata_path: - pmm: oscars template_variables: - collection_section: 9 + collection_section: 8 collection_mode: show_items collection_order: alpha - imdb_sort: moviemeter,asc radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> ``` + diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md index cc1d1cc0..b049860d 100644 --- a/docs/defaults/award/other.md +++ b/docs/defaults/award/other.md @@ -1,6 +1,6 @@ # Other Awards Default Metadata File -The `- pmm: other` Metadata File is used to create collections based on numerous other awards. +The `- pmm: other_award` Metadata File is used to create collections based on numerous other awards. This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) @@ -13,42 +13,32 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: other + - pmm: other_award ``` ## 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 from the default settings which are provided. -Below are the available variables which can be used to customize the file. +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 just ignored. +All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Usage | Default Value | Values | -|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` | -| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` | -| radarr_folder | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | +| Variable | Description & Values | +|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -The below shows an example config.yml with all the template_variables set away from their defaults: +The below shows an example config.yml with template_variables set away from their defaults: ```yaml libraries: Movies: metadata_path: - - pmm: other + - pmm: other_award template_variables: - collection_section: 9 + collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> ``` - diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index a92d6efe..62258902 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -18,23 +18,18 @@ libraries: ## 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 from the default settings which are provided. -Below are the available variables which can be used to customize the file. +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 just ignored. +All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Usage | Default Value | Values | -|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` | -| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` | -| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` | -| radarr_folder | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | +| Variable | Description & Values | +|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the values of the collections
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| The below shows an example config.yml with all the template_variables set away from their defaults: @@ -44,12 +39,10 @@ libraries: metadata_path: - pmm: spirit template_variables: - collection_section: 9 + collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> ``` + diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index 5c1ab29b..76806811 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -18,23 +18,18 @@ libraries: ## 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 from the default settings which are provided. -Below are the available variables which can be used to customize the file. +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 just ignored. +All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Usage | Default Value | Values | -|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` | -| collection_section | Controls the sort order of these collections against other default collections | `16` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` | -| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` | -| radarr_folder | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | +| Variable | Description & Values | +|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `data` | **Description:** Changes the values of the collections
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| The below shows an example config.yml with all the template_variables set away from their defaults: @@ -44,12 +39,10 @@ libraries: metadata_path: - pmm: sundance template_variables: - collection_section: 9 + collection_section: 8 collection_mode: show_items collection_order: alpha radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> ``` + diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index 3b1bbef9..e54b75de 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -28,16 +28,21 @@ Note that the `templates_variables:` section only needs to be used if you do NOT Below are the available variables which can be used to customize the actor file. -| Variable | Usage | Default Value | Values | -|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or
`rainier` - Rainier theme | -| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) | -| collection_section | Controls the sort order of these collections against other default collections | `17` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| use_separator | Controls whether a separator is created | `true` | `true` or `false` | -| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | -| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items | +| Variable | Description & Values | +|:------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `style ` | **Description:** Controls the visual theme of the collections created
**Values:** `bw` - Black and white theme or
`rainier` - Rainier theme | +| `sort_by` | **Description:** Controls the sort method for the collections
**Values:** Any sort method in the [Sorts Options Table](#sort-options) | +| `data` | **Description:** Changes the Collection Order
**Values:**
| + +test + + + +| Variable | Usage | Default Value | Values | +|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| style | | `bw` | `bw` - Black and white theme or
`rainier` - Rainier theme | +| sort_by | Controls the sort method for the collections | `release.desc` | | +| `data` | **Description:** Changes the Collection Order
**Values:**
AttributeDescription & Values
depthValues: Number greater than 0Default: 0
limitValues: Number greater than 1Default: 1
AttributeDescription & Values
startingValues: Number greater than 0Default: 0
endingValues: Number greater than 1Default: 1
incrementValues: Number greater than 0Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| The below shows an example config.yml with all the template_variables set away from their defaults: