From 0c33e346c6eb16de1febfce014b7dbc5a94caf4a Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Tue, 28 Nov 2023 18:33:06 +0000 Subject: [PATCH] fix bad links --- docs/builders/details/definition.md | 2 +- docs/defaults/collection_variables.md | 90 +++++++++++++-------------- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/builders/details/definition.md b/docs/builders/details/definition.md index f277f924..8d665f07 100644 --- a/docs/builders/details/definition.md +++ b/docs/builders/details/definition.md @@ -38,7 +38,7 @@ All the following attributes serve various functions as how the definition funct | `default_percent` | **Description:** Used to declare the default percent for `episodes`, `seasons`, `tracks`, and `albums` [special filters](../filters.md#special-filters). Default is 50.
**Values:** Integer between 1 and 100 | | `ignore_blank_results` | **Description:** Used to not have Errors resulting from blank results from builders.
**Default:** `false`
**Values:** `true` or `false` | | `only_run_on_create` | **Description:** Used to only run the collection definition if the collection doesn't already exist.
**Default:** `false`
**Values:** `true` or `false` | -| `delete_collections_named` | **Description:** Used to delete any collections in your plex named one of the given collections.
**Values:** List of Collection Names to delete |[environmental.md](..%2F..%2Fpmm%2Fessentials%2Fenvironmental.md) +| `delete_collections_named` | **Description:** Used to delete any collections in your plex named one of the given collections.
**Values:** List of Collection Names to delete | An example of using `default_percent` which is used in an external yml file and not within config.yml: ```yml diff --git a/docs/defaults/collection_variables.md b/docs/defaults/collection_variables.md index a0324ef2..ca41402a 100644 --- a/docs/defaults/collection_variables.md +++ b/docs/defaults/collection_variables.md @@ -12,56 +12,56 @@ Note that the `template_variables:` section only needs to be used if you do want Below are the common variables which can be used to customize the file. -| Variable | Description & Values | -|:-----------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `language` | **Description:** Set the language of Collection Names and Summaries
**Default:** `default`
**Values:** `default` (English), `fr` (French), or `de` (German) | -| `use_<>`1 | **Description:** Turns off individual Collections in a Defaults file.
**Values:** `false` to turn off the collection | -| `name_<>`1 | **Description:** Changes the name of the specified key's collection.
**Values:** New Collection Name | -| `summary_<>`1 | **Description:** Changes the summary of the specified key's collection.
**Values:** New Collection Summary | -| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | -| `sort_prefix` | **Description:** Changes the prefix of the sort title.
**Default:** `!`
**Values:** Any String | -| `sort_title` | **Description:** Changes the sort title of all collections.
**Default:** `<><><
><>>><>`<br>**Values:** Any String                                                                                                                                                                                                                            |
-| `name_mapping`                           | **Description:** Changes the `name_mapping` of all collections.<br>**Default:** `<<title>>`<br>**Values:** Any String with `<<key_name>>` in it.                                                                                                                                                                                                                                                          |
-| `order_<<key>>`<sup>1</sup>              | **Description:** Controls the sort order of the collections in their collection section.<br>**Values:** Any number                                                                                                                                                                                                                                                                                        |
-| `collection_mode`                        | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table>                     |
-| `ignore_ids`                             | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs                                                                                                                                                                                                                                       |
-| `ignore_imdb_ids`                        | **Description:** Set a list or comma-separated string of IMDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of IMDb IDs                                                                                                                                                                                                                                                 |
-| `minimum_items`                          | **Description:** Set the number of minimum items for a collection to be created for all collections.<br>**Values:** Any number greater than 0                                                                                                                                                                                                                                                             |
-| `minimum_items_<<key>>`<sup>1</sup>      | **Description:** Set the number of minimum items for a collection to be created for the specified key's collection.<br>**Values:** Any number greater than 0                                                                                                                                                                                                                                              |
-| `delete_collections_named`               | **Description:** Used to delete any collections in your plex named one of the given collections.<br>**Values:** List of Collection Names to delete                                                                                                                                                                                                                                                        |
-| `url_poster`                             | **Description:** Changes the poster url for all collections.<br>**Values:** URL directly to the Image                                                                                                                                                                                                                                                                                                     |
-| `url_poster_<<key>>`<sup>1</sup>         | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image                                                                                                                                                                                                                                                                                       |
-| `file_poster`                            | **Description:** Sets the poster filepath for all collections.<br>**Values:** Filepath directly to the Image                                                                                                                                                                                                                                                                                              |
-| `file_poster_<<key>>`<sup>1</sup>        | **Description:** Sets the poster filepath of the specified key's collection.<br>**Values:** Filepath directly to the Image                                                                                                                                                                                                                                                                                |
-| `url_background`                         | **Description:** Sets the background url for all collections.<br>**Values:** URL directly to the Image                                                                                                                                                                                                                                                                                                    |
-| `url_background__<<key>>`<sup>1</sup>    | **Description:** Sets the background url of the specified key's collection.<br>**Values:** URL directly to the Image                                                                                                                                                                                                                                                                                      |
-| `file_background`                        | **Description:** Sets the background filepath for all collections.<br>**Values:** Filepath directly to the Image                                                                                                                                                                                                                                                                                          |
-| `file_background__<<key>>`<sup>1</sup>   | **Description:** Sets the background filepath of the specified key's collection.<br>**Values:** Filepath directly to the Image                                                                                                                                                                                                                                                                            |
+| Variable                                 | Description & Values                                                                                                                                                                                                                                                                                                                                                                                         |
+|:-----------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `language`                               | **Description:** Set the language of Collection Names and Summaries<br>**Default:** `default`<br>**Values:** `default` (English), `fr` (French), or `de` (German)                                                                                                                                                                                                                                            | 
+| `use_<<key>>`<sup>1</sup>                | **Description:** Turns off individual Collections in a Defaults file.<br>**Values:** `false` to turn off the collection                                                                                                                                                                                                                                                                                      |
+| `name_<<key>>`<sup>1</sup>               | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name                                                                                                                                                                                                                                                                                                      |
+| `summary_<<key>>`<sup>1</sup>            | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary                                                                                                                                                                                                                                                                                                |
+| `collection_section`                     | **Description:** Changes the sort order of the collection sections against other default collection sections. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number                                                                                                                                                                                                                        |
+| `sort_prefix`                            | **Description:** Changes the prefix of the sort title.<br>**Default:** `!`<br>**Values:** Any String                                                                                                                                                                                                                                                                                                         |
+| `sort_title`                             | **Description:** Changes the sort title of all collections.<br>**Default:** `<<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>>`<br>**Values:** Any String                                                                                                                                                                                                                               |
+| `name_mapping`                           | **Description:** Changes the `name_mapping` of all collections.<br>**Default:** `<<title>>`<br>**Values:** Any String with `<<key_name>>` in it.                                                                                                                                                                                                                                                             |
+| `order_<<key>>`<sup>1</sup>              | **Description:** Controls the sort order of the collections in their collection section.<br>**Values:** Any number                                                                                                                                                                                                                                                                                           |
+| `collection_mode`                        | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table>                        |
+| `ignore_ids`                             | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs                                                                                                                                                                                                                                          |
+| `ignore_imdb_ids`                        | **Description:** Set a list or comma-separated string of IMDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of IMDb IDs                                                                                                                                                                                                                                                    |
+| `minimum_items`                          | **Description:** Set the number of minimum items for a collection to be created for all collections.<br>**Values:** Any number greater than 0                                                                                                                                                                                                                                                                |
+| `minimum_items_<<key>>`<sup>1</sup>      | **Description:** Set the number of minimum items for a collection to be created for the specified key's collection.<br>**Values:** Any number greater than 0                                                                                                                                                                                                                                                 |
+| `delete_collections_named`               | **Description:** Used to delete any collections in your plex named one of the given collections.<br>**Values:** List of Collection Names to delete                                                                                                                                                                                                                                                           |
+| `url_poster`                             | **Description:** Changes the poster url for all collections.<br>**Values:** URL directly to the Image                                                                                                                                                                                                                                                                                                        |
+| `url_poster_<<key>>`<sup>1</sup>         | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image                                                                                                                                                                                                                                                                                          |
+| `file_poster`                            | **Description:** Sets the poster filepath for all collections.<br>**Values:** Filepath directly to the Image                                                                                                                                                                                                                                                                                                 |
+| `file_poster_<<key>>`<sup>1</sup>        | **Description:** Sets the poster filepath of the specified key's collection.<br>**Values:** Filepath directly to the Image                                                                                                                                                                                                                                                                                   |
+| `url_background`                         | **Description:** Sets the background url for all collections.<br>**Values:** URL directly to the Image                                                                                                                                                                                                                                                                                                       |
+| `url_background__<<key>>`<sup>1</sup>    | **Description:** Sets the background url of the specified key's collection.<br>**Values:** URL directly to the Image                                                                                                                                                                                                                                                                                         |
+| `file_background`                        | **Description:** Sets the background filepath for all collections.<br>**Values:** Filepath directly to the Image                                                                                                                                                                                                                                                                                             |
+| `file_background__<<key>>`<sup>1</sup>   | **Description:** Sets the background filepath of the specified key's collection.<br>**Values:** Filepath directly to the Image                                                                                                                                                                                                                                                                               |
 | `visible_library`                        | **Description:** Controls visible on Library Recommended Tab for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../builders/details/schedule.md)</td><td>Visible When Scheduled</td></tr></table>                              |
 | `visible_library_<<key>>`<sup>1</sup>    | **Description:** Controls visible on Library Recommended Tab of the specified key's collection. (Only works with Plex Pass)<br>**Default:** `visible_library`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../builders/details/schedule.md)</td><td>Visible When Scheduled</td></tr></table> |
 | `visible_home`                           | **Description:** Controls visible on Home Tab for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../builders/details/schedule.md)</td><td>Visible When Scheduled</td></tr></table>                                             |
 | `visible_home_<<key>>`<sup>1</sup>       | **Description:** Controls visible on Home Tab of the specified key's collection. (Only works with Plex Pass)<br>**Default:** `visible_home`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../builders/details/schedule.md)</td><td>Visible When Scheduled</td></tr></table>                   |
 | `visible_shared`                         | **Description:** Controls visible on Shared Users' Home Tab for all collections in a Defaults file. (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../builders/details/schedule.md)</td><td>Visible When Scheduled</td></tr></table>                               |
 | `visible_shared_<<key>>`<sup>1</sup>     | **Description:** Controls visible on Shared Users' Home Tab of the specified key's collection. (Only works with Plex Pass)<br>**Default:** `visible_shared`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../builders/details/schedule.md)</td><td>Visible When Scheduled</td></tr></table>   |
-| `radarr_add_missing`                     | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                                         |
-| `radarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `add_missing` attribute of the specified key's collection.<br>**Default:** `radarr_add_missing`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                         |
-| `radarr_folder`                          | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path                                                                                                                                                                                                                                                                          |
-| `radarr_folder_<<key>>`<sup>1</sup>      | **Description:** Override Radarr `root_folder_path` attribute of the specified key's collection.<br>**Default:** `radarr_folder`<br>**Values:** Folder Path        [schedule.md](..%2Fbuilders%2Fdetails%2Fschedule.md)                                                                                                                                                                                                                                       |
-| `radarr_search`                          | **Description:** Override Radarr `search` attribute or all collections in a Defaults file.<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                                               |
-| `radarr_search_<<key>>`<sup>1</sup>      | **Description:** Override Radarr `search` attribute of the specified key's collection.<br>**Default:** `radarr_search`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                   |
-| `radarr_tag`                             | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                                                                            |
-| `radarr_tag_<<key>>`<sup>1</sup>         | **Description:** Override Radarr `tag` attribute of the specified key's collection.<br>**Default:** `radarr_tag`<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                                                    |
-| `item_radarr_tag`                        | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                      |
-| `item_radarr_tag_<<key>>`<sup>1</sup>    | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.<br>**Default:** `item_radarr_tag`<br>**Values:** List or comma-separated string of tags                                                                                                                                                                         |
-| `sonarr_add_missing`                     | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                                         |
-| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the specified key's collection.<br>**Default:** `sonarr_add_missing`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                         |
-| `sonarr_folder`                          | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path                                                                                                                                                                                                                                                                          |
-| `sonarr_folder_<<key>>`<sup>1</sup>      | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's collection.<br>**Default:** `sonarr_folder`<br>**Values:** Folder Path                                                                                                                                                                                                                                               |
-| `sonarr_search`                          | **Description:** Override Sonarr `search` attribute or all collections in a Defaults file.<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                                               |
-| `sonarr_search_<<key>>`<sup>1</sup>      | **Description:** Override Sonarr `search` attribute of the specified key's collection.<br>**Default:** `sonarr_search`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                   |
-| `sonarr_tag`                             | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                                                                            |
-| `sonarr_tag_<<key>>`<sup>1</sup>         | **Description:** Override Sonarr `tag` attribute of the specified key's collection.<br>**Default:** `sonarr_tag`<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                                                    |
-| `item_sonarr_tag`                        | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                     |
-| `item_sonarr_tag_<<key>>`<sup>1</sup>    | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's collection.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags                                                                                                                                                                        |
+| `radarr_add_missing`                     | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                                            |
+| `radarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Radarr `add_missing` attribute of the specified key's collection.<br>**Default:** `radarr_add_missing`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                            |
+| `radarr_folder`                          | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path                                                                                                                                                                                                                                                                             |
+| `radarr_folder_<<key>>`<sup>1</sup>      | **Description:** Override Radarr `root_folder_path` attribute of the specified key's collection.<br>**Default:** `radarr_folder`<br>**Values:** Folder Path                                                                                                                                                                                                                                                  |
+| `radarr_search`                          | **Description:** Override Radarr `search` attribute or all collections in a Defaults file.<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                                                  |
+| `radarr_search_<<key>>`<sup>1</sup>      | **Description:** Override Radarr `search` attribute of the specified key's collection.<br>**Default:** `radarr_search`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                      |
+| `radarr_tag`                             | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                                                                               |
+| `radarr_tag_<<key>>`<sup>1</sup>         | **Description:** Override Radarr `tag` attribute of the specified key's collection.<br>**Default:** `radarr_tag`<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                                                       |
+| `item_radarr_tag`                        | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                         |
+| `item_radarr_tag_<<key>>`<sup>1</sup>    | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.<br>**Default:** `item_radarr_tag`<br>**Values:** List or comma-separated string of tags                                                                                                                                                                            |
+| `sonarr_add_missing`                     | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                                            |
+| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the specified key's collection.<br>**Default:** `sonarr_add_missing`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                            |
+| `sonarr_folder`                          | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path                                                                                                                                                                                                                                                                             |
+| `sonarr_folder_<<key>>`<sup>1</sup>      | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's collection.<br>**Default:** `sonarr_folder`<br>**Values:** Folder Path                                                                                                                                                                                                                                                  |
+| `sonarr_search`                          | **Description:** Override Sonarr `search` attribute or all collections in a Defaults file.<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                                                  |
+| `sonarr_search_<<key>>`<sup>1</sup>      | **Description:** Override Sonarr `search` attribute of the specified key's collection.<br>**Default:** `sonarr_search`<br>**Values:** `true` or `false`                                                                                                                                                                                                                                                      |
+| `sonarr_tag`                             | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                                                                               |
+| `sonarr_tag_<<key>>`<sup>1</sup>         | **Description:** Override Sonarr `tag` attribute of the specified key's collection.<br>**Default:** `sonarr_tag`<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                                                       |
+| `item_sonarr_tag`                        | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags                                                                                                                                                                                                        |
+| `item_sonarr_tag_<<key>>`<sup>1</sup>    | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's collection.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags                                                                                                                                                                           |
 
 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.