From 4990c9159017ed90a1b06e7a473ae7d6eaf8f4f8 Mon Sep 17 00:00:00 2001 From: Chaz Larson Date: Wed, 28 Aug 2024 13:27:28 -0500 Subject: [PATCH] Doc changes 8 28 (#2209) --- docs/config/libraries.md | 2 +- docs/config/schedule.md | 4 +- docs/defaults/both/actor.md | 2 +- docs/defaults/both/audio_language.md | 20 ++- docs/defaults/both/collectionless.md | 12 +- docs/defaults/both/content_rating_au.md | 16 +- docs/defaults/both/content_rating_cs.md | 16 +- docs/defaults/both/content_rating_de.md | 16 +- docs/defaults/both/content_rating_mal.md | 16 +- docs/defaults/both/content_rating_nz.md | 16 +- docs/defaults/both/content_rating_uk.md | 16 +- docs/defaults/both/genre.md | 8 +- docs/defaults/both/resolution.md | 8 +- docs/defaults/both/studio.md | 16 +- docs/defaults/both/subtitle_language.md | 16 +- docs/defaults/both/universe.md | 24 ++- docs/defaults/chart/tautulli.md | 1 + docs/defaults/movie/content_rating_us.md | 16 +- docs/defaults/movie/continent.md | 16 +- docs/defaults/movie/country.md | 16 +- docs/defaults/movie/director.md | 2 +- docs/defaults/movie/franchise.md | 34 +++- docs/defaults/movie/producer.md | 2 +- docs/defaults/movie/region.md | 16 +- docs/defaults/movie/seasonal.md | 66 ++++++-- docs/defaults/movie/writer.md | 2 +- docs/defaults/playlist.md | 4 +- docs/defaults/show/content_rating_us.md | 16 +- docs/defaults/show/continent.md | 16 +- docs/defaults/show/country.md | 16 +- docs/defaults/show/franchise.md | 16 +- docs/defaults/show/network.md | 16 +- docs/defaults/show/region.md | 16 +- docs/files/builders/overview.md | 196 +++++++++++------------ docs/files/collections.md | 4 +- docs/files/overlays.md | 4 +- docs/files/playlists.md | 2 +- docs/kometa/guides/order.md | 8 +- docs/kometa/guides/scheduling.md | 4 +- docs/kometa/logs.md | 2 +- docs/notused/playlists.md | 4 +- docs/showcase/overlays.md | 4 +- docs/stylesheets/extra.css | 4 +- 43 files changed, 525 insertions(+), 186 deletions(-) diff --git a/docs/config/libraries.md b/docs/config/libraries.md index 7b8c9038..59a5acc4 100644 --- a/docs/config/libraries.md +++ b/docs/config/libraries.md @@ -13,7 +13,7 @@ Attributes are used to instruct Kometa what actions to take, such as "load the f be inherited from the global value if it has been set. If an attribute is specified at both the library and global level, then the library level attribute will take priority. -### Attributes +## Attributes The available attributes for each library are as follows: diff --git a/docs/config/schedule.md b/docs/config/schedule.md index 60fcee98..ebd5d014 100644 --- a/docs/config/schedule.md +++ b/docs/config/schedule.md @@ -36,7 +36,7 @@ The scheduling options are: ??? blank "Scheduling a Library" -
Uses the `schedule` [Library Attribute](libraries.md#Attributes) to set when a library will be run. +
Uses the `schedule` [Library Attribute](libraries.md#attributes) to set when a library will be run. Other schedule rules for files, overlays, collections, and any other attribute that can be scheduled must also be met. @@ -61,7 +61,7 @@ The scheduling options are: ??? blank "Scheduling Collection, Playlist, and Metadata Files" -
Uses the `schedule` [Block Attribute](files.md#Other-Block-Attributes) to set when a file +
Uses the `schedule` [Block Attribute](files.md#other-block-attributes) to set when a file will be run. Other schedule rules for collections and any other attribute that can be scheduled must also be met. diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index e83dafb9..c1e6a657 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -98,7 +98,7 @@ work. Any value not specified will use its default value if it has one if not it 1. Check the first 10 casting credits in each movie 2. Create 20 collections maximum - 3. use the [diiivoy Color Style](#diiivoy-color-style) + 3. use the [diiivoy Color Style](#poster-styles) 4. Do not create an "Actors Collections" separator 5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index b444a523..da5be2b5 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -60,7 +60,7 @@ work. Any value not specified will use its default value if it has one if not it | `append_include` | **Description:** Appends to the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `remove_include` | **Description:** Removes from the [default include list](#include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | - | `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).
**Values:** Dictionary with `key: new_key_name` entries | + | `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).
**Values:** Dictionary with `key: new_key_name` entries | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> Audio`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in the <> Language.`
**Values:** Any string. | @@ -113,7 +113,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/both/audio_language.yml" comments=false @@ -127,11 +133,17 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### key_name_override: {% include-markdown "../../../defaults/both/audio_language.yml" comments=false preserve-includer-indent=false start="key_name_override:" %} - ``` + ``` \ No newline at end of file diff --git a/docs/defaults/both/collectionless.md b/docs/defaults/both/collectionless.md index effb02e6..dd4dd46d 100644 --- a/docs/defaults/both/collectionless.md +++ b/docs/defaults/both/collectionless.md @@ -69,7 +69,7 @@ work. Any value not specified will use its default value if it has one if not it | `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**Default:** `alpha`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `url_poster` | **Description:** Changes the poster url of the collection.
**Values:** URL directly to the Image | | `exclude` | **Description:** Exclude these Collections from being considered for collectionless.
**Values:** List of Collections | - | `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.
**Default:** [default exclude_prefix list](#default-exclude_prefix)
**Values:** List of Prefixes | | + | `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.
**Default:** [default exclude_prefix list](#exclude-prefix)
**Values:** List of Prefixes | | ???+ example "Example Template Variable Amendments" @@ -101,7 +101,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/both/collectionless.yml" comments=false @@ -110,4 +116,4 @@ If you want to customize these values, use the methods described above. start="# check1" end="# check2" %} - ``` + ``` \ No newline at end of file diff --git a/docs/defaults/both/content_rating_au.md b/docs/defaults/both/content_rating_au.md index 84a75e80..499c73cc 100644 --- a/docs/defaults/both/content_rating_au.md +++ b/docs/defaults/both/content_rating_au.md @@ -123,7 +123,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/both/content_rating_au.yml" comments=false @@ -137,7 +143,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/both/content_rating_au.yml" comments=false diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index 2d57b662..f38edf25 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -125,7 +125,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/both/content_rating_cs.yml" comments=false @@ -139,7 +145,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/both/content_rating_cs.yml" comments=false diff --git a/docs/defaults/both/content_rating_de.md b/docs/defaults/both/content_rating_de.md index bae7edb5..5257e9ff 100644 --- a/docs/defaults/both/content_rating_de.md +++ b/docs/defaults/both/content_rating_de.md @@ -123,7 +123,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/both/content_rating_de.yml" comments=false @@ -137,7 +143,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/both/content_rating_de.yml" comments=false diff --git a/docs/defaults/both/content_rating_mal.md b/docs/defaults/both/content_rating_mal.md index c3ac2253..d684b739 100644 --- a/docs/defaults/both/content_rating_mal.md +++ b/docs/defaults/both/content_rating_mal.md @@ -132,7 +132,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/both/content_rating_mal.yml" comments=false @@ -146,7 +152,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/both/content_rating_mal.yml" comments=false diff --git a/docs/defaults/both/content_rating_nz.md b/docs/defaults/both/content_rating_nz.md index a0780ea3..5a1c9646 100644 --- a/docs/defaults/both/content_rating_nz.md +++ b/docs/defaults/both/content_rating_nz.md @@ -123,7 +123,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/both/content_rating_nz.yml" comments=false @@ -137,7 +143,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/both/content_rating_nz.yml" comments=false diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index d8bfdc1b..31ff55d0 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -123,7 +123,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/both/content_rating_uk.yml" comments=false @@ -137,7 +143,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/both/content_rating_uk.yml" comments=false diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index 712f334c..1e55331c 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -119,7 +119,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/both/genre.yml" comments=false diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index 6c07f6e0..3d7b7671 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -137,7 +137,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/both/resolution.yml" comments=false diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index 0a74785d..e9877f98 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -117,7 +117,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/both/studio.yml" comments=false @@ -131,7 +137,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/both/studio.yml" comments=false diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index 9d679183..41f4ff4a 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -113,7 +113,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/both/subtitle_language.yml" comments=false @@ -127,7 +133,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### key_name_override: {% include-markdown "../../../defaults/both/subtitle_language.yml" comments=false diff --git a/docs/defaults/both/universe.md b/docs/defaults/both/universe.md index 48ca3c66..ae1d023c 100644 --- a/docs/defaults/both/universe.md +++ b/docs/defaults/both/universe.md @@ -131,7 +131,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### data: {% include-markdown "../../../defaults/both/universe.yml" comments=false @@ -145,7 +151,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/both/universe.yml" comments=false @@ -160,7 +172,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/both/universe.yml" comments=false diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 27ef12bc..58bcbb8e 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -8,6 +8,7 @@ The `tautulli` Default Collection File is used to create collections based on Ta Supported Library Types: Movie, Show + Requirements: [Tautulli Authentication](../../config/tautulli.md) ## Collections Section 020 diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index 8d81206b..997dd920 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -122,7 +122,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/movie/content_rating_us.yml" comments=false @@ -136,7 +142,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/movie/content_rating_us.yml" comments=false diff --git a/docs/defaults/movie/continent.md b/docs/defaults/movie/continent.md index 7822c367..6874876c 100644 --- a/docs/defaults/movie/continent.md +++ b/docs/defaults/movie/continent.md @@ -124,7 +124,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/movie/continent.yml" comments=false @@ -138,7 +144,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/movie/continent.yml" comments=false diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index 498678c7..6552a969 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -124,7 +124,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/movie/country.yml" comments=false @@ -138,7 +144,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/movie/country.yml" comments=false diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index 1e8e6dae..bfc3df3c 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -101,7 +101,7 @@ work. Any value not specified will use its default value if it has one if not it 1. Check the first 10 casting credits in each movie 2. Create 20 collections maximum - 3. use the [rainier Style](#rainier-style) + 3. use the [rainier Style](#poster-styles) 4. Do not create a "Directors Collections" separator 5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 8a22e828..5a7784f1 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -58,7 +58,7 @@ work. Any value not specified will use its default value if it has one if not it | `collection_mode` | **Description:** Controls the collection mode of all collections in this file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| | `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | | `movie_<>`1 | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#movie) for that collection if used.
**Values:** List of TMDb Movie IDs | - | `name_mapping_<>`1 | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#name_mapping) for that collection if used.
**Values:** Any String | + | `name_mapping_<>`1 | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#name-mapping) for that collection if used.
**Values:** Any String | | `sort_title` | **Description:** Sets the sort title for all collections. Use `<>` to use the collection name. **Example:** `"!02_<>"`
**Values:** Any String with `<>` | | `sort_title_<>`1 | **Description:** Sets the sort title of the specified key's collection.
**Default:** `sort_title`
**Values:** Any String | | `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.
**Values:** `false` to not build the collection | @@ -118,7 +118,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/movie/franchise.yml" comments=false @@ -132,7 +138,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### title_override: {% include-markdown "../../../defaults/movie/franchise.yml" comments=false @@ -150,7 +162,13 @@ If you want to customize these values, use the methods described above. Pass `movie_<>` to the file as template variables to change this value per collection. - ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/movie/franchise.yml" comments=false @@ -169,7 +187,13 @@ If you want to customize these values, use the methods described above. Pass `name_mapping_<>` to the file as template variables to change this value per collection. - ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/movie/franchise.yml" comments=false diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index 5770abf0..6c1adaec 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -101,7 +101,7 @@ work. Any value not specified will use its default value if it has one if not it 1. Check the first 15 casting credits in each movie 2. Create 5 collections maximum - 3. use the [rainier Style](#signature-style) + 3. use the [rainier Style](#poster-styles) 4. Do not create a "Producers Collections" separator 5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb diff --git a/docs/defaults/movie/region.md b/docs/defaults/movie/region.md index dac5e63b..215f2743 100644 --- a/docs/defaults/movie/region.md +++ b/docs/defaults/movie/region.md @@ -128,7 +128,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/movie/region.yml" comments=false @@ -142,7 +148,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/movie/region.yml" comments=false diff --git a/docs/defaults/movie/seasonal.md b/docs/defaults/movie/seasonal.md index 4c384299..869ae0ac 100644 --- a/docs/defaults/movie/seasonal.md +++ b/docs/defaults/movie/seasonal.md @@ -145,7 +145,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### data: {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false @@ -163,7 +169,13 @@ If you want to customize these values, use the methods described above. Pass `emoji_<>` to the file as template variables to change this value per collection. - ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false @@ -182,14 +194,20 @@ If you want to customize these values, use the methods described above. Pass `schedule_<>` to the file as template variables to change this value per collection. - ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false preserve-includer-indent=true dedent=true start="# check2" - end="# check3" + end="# check4" %} ``` @@ -201,7 +219,13 @@ If you want to customize these values, use the methods described above. Pass `imdb_search_<>` to the file as template variables to change this value per collection. - ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false @@ -220,7 +244,13 @@ If you want to customize these values, use the methods described above. Pass `tmdb_collection_<>` to the file as template variables to change this value per collection. - ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false @@ -239,7 +269,13 @@ If you want to customize these values, use the methods described above. Pass `tmdb_movie_<>` to the file as template variables to change this value per collection. - ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false @@ -258,7 +294,13 @@ If you want to customize these values, use the methods described above. Pass `mdblist_list_<>` to the file as template variables to change this value per collection. - ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false @@ -277,7 +319,13 @@ If you want to customize these values, use the methods described above. Pass `trakt_list_<>` to the file as template variables to change this value per collection. - ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### {% include-markdown "../../../defaults/movie/seasonal.yml" comments=false diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index 31a1fafd..7289b526 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -101,7 +101,7 @@ work. Any value not specified will use its default value if it has one if not it 1. Check the first 10 casting credits in each movie 2. Create 20 collections maximum - 3. use the [diivivoy Style](#rainier-style) + 3. use the [diivivoy Style](#poster-styles) 4. Do not create a "Writers Collections" separator 5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb diff --git a/docs/defaults/playlist.md b/docs/defaults/playlist.md index 417daf8d..1d878616 100644 --- a/docs/defaults/playlist.md +++ b/docs/defaults/playlist.md @@ -62,7 +62,7 @@ work. Any value not specified will use its default value if it has one if not it | `sync_to_users_<>`1 | **Description:** Sets the users to sync the specified key's playlist to.
**Default:** `sync_to_user` Value
**Values:** Comma-separated string or list of user names. | | `exclude_user` | **Description:** Sets the users to exclude from sync for all playlists.
**Default:** `playlist_sync_to_users` Global Setting Value
**Values:** Comma-separated string or list of user names. | | `exclude_user_<>`1 | **Description:** Sets the users to exclude from sync the specified key's playlist.
**Default:** `sync_to_users` Value
**Values:** Comma-separated string or list of user names. | - | `trakt_list_<>`1 | **Description:** Adds the Movies in the Trakt List to the specified key's playlist. Overrides the [default trakt_list](#default-trakt_list) for that playlist if used.
**Values:** List of Trakt List URLs | | | | + | `trakt_list_<>`1 | **Description:** Adds the Movies in the Trakt List to the specified key's playlist. Overrides the [default trakt_list] for that playlist if used.
**Values:** List of Trakt List URLs | | | | | `delete_playlist` | **Description:** Will delete all playlists for the users defined by sync_to_users.
**Values:** `true` or `false` | | `delete_playlist_<>`1 | **Description:** Will delete the specified key's playlists for the users defined by sync_to_users.
**Values:** `true` or `false` | | `ignore_ids` | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all playlists.
**Values:** List or comma-separated string of TMDb/TVDb IDs | @@ -110,7 +110,7 @@ show how to change a name or a list.** If you want to customize these values, use the methods described above. ??? example "Default Template Variable `trakt_list` (click to expand) " - +
???+ tip diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index 5fa1e9fa..36cdbf4c 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -120,7 +120,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/show/content_rating_us.yml" comments=false @@ -134,7 +140,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/show/content_rating_us.yml" comments=false diff --git a/docs/defaults/show/continent.md b/docs/defaults/show/continent.md index b74ccb63..5f923b53 100644 --- a/docs/defaults/show/continent.md +++ b/docs/defaults/show/continent.md @@ -114,7 +114,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/show/continent.yml" comments=false @@ -128,7 +134,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/show/continent.yml" comments=false diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index eb68726a..2a40227b 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -114,7 +114,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/show/country.yml" comments=false @@ -128,7 +134,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/show/country.yml" comments=false diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index 55cbcd36..f3f9ee83 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -120,7 +120,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### data: {% include-markdown "../../../defaults/show/franchise.yml" comments=false @@ -134,7 +140,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/show/franchise.yml" comments=false diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index f72c8a0b..d956e631 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -128,7 +128,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/show/network.yml" comments=false @@ -142,7 +148,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/show/network.yml" comments=false diff --git a/docs/defaults/show/region.md b/docs/defaults/show/region.md index 6a462526..82d2e5ff 100644 --- a/docs/defaults/show/region.md +++ b/docs/defaults/show/region.md @@ -129,7 +129,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### include: {% include-markdown "../../../defaults/show/region.yml" comments=false @@ -143,7 +149,13 @@ If you want to customize these values, use the methods described above.
- ```yaml + ```{ .dtd .no-copy } + ############################################################################### + ################################## IMPORTANT ################################## + ##################### THIS DATA IS PROVIDED FOR REFERENCE #################### + ## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ### + ############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############ + ############################################################################### addons: {% include-markdown "../../../defaults/show/region.yml" comments=false diff --git a/docs/files/builders/overview.md b/docs/files/builders/overview.md index e977a18f..c4f37603 100644 --- a/docs/files/builders/overview.md +++ b/docs/files/builders/overview.md @@ -4,250 +4,250 @@ Builders use third-party services to source items to be added to the collection. !!! builder - ![Smart Plex logo](../../../assets/icons/plex.png){ align=right } + ![Smart Plex logo](../../assets/icons/plex.png){ align=right } - **[Plex (Smart)](../smart)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run Kometa. + **[Plex (Smart)](smart.md)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run Kometa. - [:octicons-home-16: View Builder](../smart){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](smart.md){ .md-button .md-button--primary } [:octicons-alert-24:](""){ .card-link title="Cannot be used for Overlays unless utilizing Smart Labels" } ??? quicklink "Popular Builders" - - [:simple-plex: Smart Label](../smart/#smart-label) - Create a Smart Collection based on a specific label. The label can be generated by Kometa based on criteria. - - [:simple-plex: Smart Filter](../smart/#smart-filter) - Create a Smart Collection based on the filter parameters provided. + - [:simple-plex: Smart Label](smart.md#smart-label) - Create a Smart Collection based on a specific label. The label can be generated by Kometa based on criteria. + - [:simple-plex: Smart Filter](smart.md#smart-filter) - Create a Smart Collection based on the filter parameters provided. !!! builder - ![Dumb Plex logo](../../../assets/icons/plex_dumb.png){ align=right } + ![Dumb Plex logo](../../assets/icons/plex_dumb.png){ align=right } - **[Plex (Dumb)](../smart)** builders grab items based on the metadata inside your Plex Server. Results are static and require Kometa to re-run to update. + **[Plex (Dumb)](smart.md)** builders grab items based on the metadata inside your Plex Server. Results are static and require Kometa to re-run to update. - [:octicons-home-16: View Builder](../plex){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](plex.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:simple-plex: Plex All](../plex/#plex-all) - Gets every movie/show in your library. - - [:simple-plex: Plex Search](../plex/#plex-search) - Gets every movie/show based on the search parameters provided. - - [:simple-plex: Plex Collectionless](../plex/#plex-collectionless) - Gets every movie/show that is not in a collection. + - [:simple-plex: Plex All](plex.md#plex-all) - Gets every movie/show in your library. + - [:simple-plex: Plex Search](plex.md#plex-search) - Gets every movie/show based on the search parameters provided. + - [:simple-plex: Plex Collectionless](plex.md#plex-collectionless) - Gets every movie/show that is not in a collection. !!! builder - ![TMDb logo](../../../assets/icons/tmdb.png){ align=right } + ![TMDb logo](../../assets/icons/tmdb.png){ align=right } - **[TMDb](../tmdb)** builders grab items based on metadata and lists on TheMovieDb.org + **[TMDb](tmdb.md)** builders grab items based on metadata and lists on TheMovieDb.org - [:octicons-home-16: View Builder](../tmdb){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](tmdb.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:simple-themoviedatabase: TMDb Collection](../tmdb/#tmdb-collection) - Gets every movie/show in your library. - - [:simple-themoviedatabase: TMDb List](../tmdb/#tmdb-list) - Gets every movie/show in your Watchlist. - - [:simple-themoviedatabase: TMDb Company](../tmdb/#tmdb-company) - Gets the first episode of every show in your library. - - [:simple-themoviedatabase: TMDb Network](../tmdb/#tmdb-network) - Gets the first episode of every show in your library. + - [:simple-themoviedatabase: TMDb Collection](tmdb.md#tmdb-collection) - Gets every movie/show in your library. + - [:simple-themoviedatabase: TMDb List](tmdb.md#tmdb-list) - Gets every movie/show in your Watchlist. + - [:simple-themoviedatabase: TMDb Company](tmdb.md#tmdb-company) - Gets the first episode of every show in your library. + - [:simple-themoviedatabase: TMDb Network](tmdb.md#tmdb-network) - Gets the first episode of every show in your library. !!! builder - ![Trakt logo](../../../assets/icons/trakt.png){ align=right } + ![Trakt logo](../../assets/icons/trakt.png){ align=right } - **[Trakt](../trakt)** builders grab items based on metadata and lists on Trakt.tv + **[Trakt](trakt.md)** builders grab items based on metadata and lists on Trakt.tv - [:octicons-home-16: View Builder](../trakt){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](trakt.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:simple-trakt: Trakt List](../trakt/#trakt-list) - Gets every movie/show in the Trakt List - - [:simple-trakt: Trakt Chart](../trakt/#trakt-chart) - Gets every movie/show in the Trakt Chart - - [:simple-trakt: Trakt Recommendations](../trakt/#trakt-recommendations) - Gets every movie/show in Trakt's Personal Recommendations for your User + - [:simple-trakt: Trakt List](trakt.md#trakt-list) - Gets every movie/show in the Trakt List + - [:simple-trakt: Trakt Chart](trakt.md#trakt-chart) - Gets every movie/show in the Trakt Chart + - [:simple-trakt: Trakt Recommendations](trakt.md#trakt-recommendations) - Gets every movie/show in Trakt's Personal Recommendations for your User !!! builder - ![MDBList logo](../../../assets/icons/mdblist.png){ align=right } + ![MDBList logo](../../assets/icons/mdblist.png){ align=right } - **[MDBList](../mdblist)** builders grab items based on lists on MDBList.com + **[MDBList](mdblist.md)** builders grab items based on lists on MDBList.com - [:octicons-home-16: View Builder](../mdblist){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](mdblist.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:octicons-list-ordered-16: MDBList List](../mdblist/#mdblist-list) - Gets every movie/show in a MDBList List. + - [:octicons-list-ordered-16: MDBList List](mdblist.md#mdblist-list) - Gets every movie/show in a MDBList List. !!! builder - ![IMDb logo](../../../assets/icons/imdb.png){ align=right } + ![IMDb logo](../../assets/icons/imdb.png){ align=right } - **[IMDb](../imdb)** builders grab items based on metadata and lists on IMDb.com + **[IMDb](imdb.md)** builders grab items based on metadata and lists on IMDb.com - [:octicons-home-16: View Builder](../imdb){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](imdb.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:simple-imdb: IMDb Chart](../imdb/#imdb-chart) - Gets every movie/show in an IMDb Chart like IMDb Top 250 Movies. - - [:simple-imdb: IMDb List](../imdb/#imdb-list) - Gets every movie/show in an IMDb List. - - [:simple-imdb: IMDb Award](../imdb/#imdb-award) - Gets every movie/show in an IMDb Event. - - [:simple-imdb: IMDb Search](../imdb/#imdb-award) - Gets every movie/show in an IMDb Search. Can also be used for Keyword searches. + - [:simple-imdb: IMDb Chart](imdb.md#imdb-chart) - Gets every movie/show in an IMDb Chart like IMDb Top 250 Movies. + - [:simple-imdb: IMDb List](imdb.md#imdb-list) - Gets every movie/show in an IMDb List. + - [:simple-imdb: IMDb Award](imdb.md#imdb-award) - Gets every movie/show in an IMDb Event. + - [:simple-imdb: IMDb Search](imdb.md#imdb-award) - Gets every movie/show in an IMDb Search. Can also be used for Keyword searches. !!! builder - ![TVDb logo](../../../assets/icons/tvdb.png){ align=right } + ![TVDb logo](../../assets/icons/tvdb.png){ align=right } - **[TVDb](../tvdb)** builders grab items based on metadata and lists on TheTVDb.com + **[TVDb](tvdb.md)** builders grab items based on metadata and lists on TheTVDb.com - [:octicons-home-16: View Builder](../tvdb){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](tvdb.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:material-television-guide: TVDb Show](../tvdb/#tvdb-show) - Grabs the specified series. - - [:material-television-guide: TVDb Movie](../tvdb/#tvdb-movie) - Gets the specified movies. - - [:material-television-guide: TVDb List](../tvdb/#tvdb-list) - Gets every item in a TVDb List or TVDb UserList. + - [:material-television-guide: TVDb Show](tvdb.md#tvdb-show) - Grabs the specified series. + - [:material-television-guide: TVDb Movie](tvdb.md#tvdb-movie) - Gets the specified movies. + - [:material-television-guide: TVDb List](tvdb.md#tvdb-list) - Gets every item in a TVDb List or TVDb UserList. !!! builder - ![BoxOfficeMojo logo](../../../assets/icons/boxofficemojo.png){ align=right } + ![BoxOfficeMojo logo](../../assets/icons/boxofficemojo.png){ align=right } - **[BoxOfficeMojo](../mojo)** builders grab items based on metadata and lists on Boxofficemojo.com + **[BoxOfficeMojo](mojo.md)** builders grab items based on metadata and lists on Boxofficemojo.com - [:octicons-home-16: View Builder](../mojo){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](mojo.md){ .md-button .md-button--primary } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } ??? quicklink "Popular Builders" - - [:material-ticket: Mojo World](../mojo/#mojo-world) - Grabs items in the Worldwide Box Office chart. - - [:material-ticket: Mojo Domestic](../mojo/#mojo-movie) - Grabs items in the Domestic Box Office chart. - - [:material-ticket: Mojo Record](../mojo/#mojo-record) - Grabs items in miscellaneous lists such as Weekend Records and Daily Records. + - [:material-ticket: Mojo World](mojo.md#mojo-world) - Grabs items in the Worldwide Box Office chart. + - [:material-ticket: Mojo Domestic](mojo.md#mojo-domestic) - Grabs items in the Domestic Box Office chart. + - [:material-ticket: Mojo Record](mojo.md#mojo-record) - Grabs items in miscellaneous lists such as Weekend Records and Daily Records. !!! builder - ![Tautulli logo](../../../assets/icons/tautulli.png){ align=right } + ![Tautulli logo](../../assets/icons/tautulli.png){ align=right } - **[Tautulli](../tautulli)** builders grab items based on lists on Tautulli + **[Tautulli](tautulli.md)** builders grab items based on lists on Tautulli - [:octicons-home-16: View Builder](../tautulli){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](tautulli.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:material-movie-search: Tautulli Popular](../tautulli/#tautulli-popular) - Gets every movie/show in the Tautulli Most Popular List - - [:material-movie-search: Tautulli Watched](../tautulli/#tautulli-watched) - Gets every movie/show in the Tautulli Most Watched List + - [:material-movie-search: Tautulli Popular](tautulli.md#tautulli-popularwatched) - Gets every movie/show in the Tautulli Most Popular List + - [:material-movie-search: Tautulli Watched](tautulli.md#tautulli-popularwatched) - Gets every movie/show in the Tautulli Most Watched List !!! builder - ![Radarr logo](../../../assets/icons/radarr.png){ align=right } + ![Radarr logo](../../assets/icons/radarr.png){ align=right } - **[Radarr](../radarr)** builders grab items based on tags in Radarr + **[Radarr](radarr.md)** builders grab items based on tags in Radarr - [:octicons-home-16: View Builder](../radarr){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](radarr.md){ .md-button .md-button--primary } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } ??? quicklink "Popular Builders" - - [:octicons-tag-16: Radarr All](../radarr/#radarr-all) - Gets every movie in Radarr - - [:octicons-tag-16: Radarr Taglist](../radarr/#radarr-taglist) - Gets every movie with the specified tags + - [:octicons-tag-16: Radarr All](radarr.md#radarr-all) - Gets every movie in Radarr + - [:octicons-tag-16: Radarr Taglist](radarr.md#radarr-taglist) - Gets every movie with the specified tags !!! builder - ![Sonarr logo](../../../assets/icons/sonarr.png){ align=right } + ![Sonarr logo](../../assets/icons/sonarr.png){ align=right } - **[Sonarr](../sonarr)** builders grab items based on tags in Sonarr + **[Sonarr](sonarr.md)** builders grab items based on tags in Sonarr - [:octicons-home-16: View Builder](../sonarr){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](sonarr.md){ .md-button .md-button--primary } [:octicons-alert-24:](""){ .card-link title="Only works with Show libraries" } ??? quicklink "Popular Builders" - - [:octicons-tag-16: Sonarr All](../sonarr/#sonarr-all) - Gets every show in Sonarr - - [:octicons-tag-16: Sonarr Taglist](../sonarr/#sonarr-taglist) - Gets every show with the specified tags + - [:octicons-tag-16: Sonarr All](sonarr.md#sonarr-all) - Gets every show in Sonarr + - [:octicons-tag-16: Sonarr Taglist](sonarr.md#sonarr-taglist) - Gets every show with the specified tags !!! builder - ![Letterboxd logo](../../../assets/icons/letterboxd.png){ align=right } + ![Letterboxd logo](../../assets/icons/letterboxd.png){ align=right } - **[Letterboxd](../letterboxd)** builders grab items based on lists on Letterboxd.com + **[Letterboxd](letterboxd.md)** builders grab items based on lists on Letterboxd.com - [:octicons-home-16: View Builder](../letterboxd){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](letterboxd.md){ .md-button .md-button--primary } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } ??? quicklink "Popular Builders" - - [:simple-letterboxd: Letterboxd List](../letterboxd/#letterboxd-list) - Gets every movie in the Letterboxd list + - [:simple-letterboxd: Letterboxd List](letterboxd.md#letterboxd-list) - Gets every movie in the Letterboxd list !!! builder - ![ICheckMovies logo](../../../assets/icons/icheckmovies.png){ align=right } + ![ICheckMovies logo](../../assets/icons/icheckmovies.png){ align=right } - **[ICheckMovies](../icheckmovies)** builders grab items based on lists on ICheckMovies.com + **[ICheckMovies](icheckmovies.md)** builders grab items based on lists on ICheckMovies.com - [:octicons-home-16: View Builder](../icheckmovies){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](icheckmovies.md){ .md-button .md-button--primary } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } ??? quicklink "Popular Builders" - - [:material-check: ICheckMovies List](../icheckmovies/#icheckmovies-list) - Gets every show in the ICheckMovies list + - [:material-check: ICheckMovies List](icheckmovies.md#icheckmovies-list) - Gets every show in the ICheckMovies list !!! builder - ![AniDB logo](../../../assets/icons/anidb.png){ align=right } + ![AniDB logo](../../assets/icons/anidb.png){ align=right } - **[AniDB](../anidb)** builders grab items based on metadata and lists on AniDB.com + **[AniDB](anidb.md)** builders grab items based on metadata and lists on AniDB.com - [:octicons-home-16: View Builder](../anidb){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](anidb.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:octicons-database-16: AniDB ID](../anidb/#anidb-id) - Finds the anime specified by the AniDB ID - - [:octicons-database-16: AniDB Popular](../anidb/#anidb-popular) - Finds every anime in AniDB's Popular Anime list - - [:octicons-database-16: AniDB Tags](../anidb/#anidb-tags) - Finds every anime with the specified AniDB Tag + - [:octicons-database-16: AniDB ID](anidb.md#anidb-id) - Finds the anime specified by the AniDB ID + - [:octicons-database-16: AniDB Popular](anidb.md#anidb-popular) - Finds every anime in AniDB's Popular Anime list + - [:octicons-database-16: AniDB Tags](anidb.md#anidb-tag) - Finds every anime with the specified AniDB Tag !!! builder - ![AniList logo](../../../assets/icons/anilist.png){ align=right } + ![AniList logo](../../assets/icons/anilist.png){ align=right } - **[AniList](../anilist)** builders grab items based on metadata and lists on AniList.com + **[AniList](anilist.md)** builders grab items based on metadata and lists on AniList.com - [:octicons-home-16: View Builder](../anilist){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](anilist.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:simple-anilist: AniList Top Rated](../anilist/#anilist-top-rated) - Gets every anime in AniList's Top Rated Anime list - - [:simple-anilist: AniList Popular](../anilist/#anilist-popular) - Gets every anime in AniList's Popular Anime list - - [:simple-anilist: AniList Trending](../anilist/#anilist-trending) - Gets every anime in AniList's Trending Anime list - - [:simple-anilist: AniList Search](../anilist/#anilist-search) - Gets every anime specified by the AniList search parameters provided + - [:simple-anilist: AniList Top Rated](anilist.md#anilist-top-rated) - Gets every anime in AniList's Top Rated Anime list + - [:simple-anilist: AniList Popular](anilist.md#anilist-popular) - Gets every anime in AniList's Popular Anime list + - [:simple-anilist: AniList Trending](anilist.md#anilist-trending) - Gets every anime in AniList's Trending Anime list + - [:simple-anilist: AniList Search](anilist.md#anilist-search) - Gets every anime specified by the AniList search parameters provided !!! builder - ![MyAnimeList logo](../../../assets/icons/myanimelist.png){ align=right } + ![MyAnimeList logo](../../assets/icons/myanimelist.png){ align=right } - **[MyAnimeList](../myanimelist)** builders grab items based on metadata and lists on MyAnimeList.com + **[MyAnimeList](myanimelist.md)** builders grab items based on metadata and lists on MyAnimeList.com - [:octicons-home-16: View Builder](../myanimelist){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](myanimelist.md){ .md-button .md-button--primary } ??? quicklink "Popular Builders" - - [:simple-myanimelist: MyAnimeList Popular](../myanimelist/#myanimelist-most-popular) - Gets every anime in MyAnimeList's Most Popular Anime list - - [:simple-myanimelist: MyAnimeList Top All](../myanimelist/#myanimelist-top-all) - Gets every anime in MyAnimeList's Top All Anime list - - [:simple-myanimelist: MyAnimeList Top Airing](../myanimelist/#myanimelist-top-airing) - Gets every anime in MyAnimeList's Top Airing Anime list - - [:simple-myanimelist: MyAnimeList Suggested](../myanimelist/#myanimelist-suggested) - Gets every suggested anime in by MyAnimeList for the authorized user + - [:simple-myanimelist: MyAnimeList Popular](myanimelist.md#myanimelist-most-popular) - Gets every anime in MyAnimeList's Most Popular Anime list + - [:simple-myanimelist: MyAnimeList Top All](myanimelist.md#myanimelist-top-all) - Gets every anime in MyAnimeList's Top All Anime list + - [:simple-myanimelist: MyAnimeList Top Airing](myanimelist.md#myanimelist-top-airing) - Gets every anime in MyAnimeList's Top Airing Anime list + - [:simple-myanimelist: MyAnimeList Suggested](myanimelist.md#myanimelist-suggested) - Gets every suggested anime in by MyAnimeList for the authorized user !!! builder - ![Reciperr logo](../../../assets/icons/reciperr.png){ align=right } + ![Reciperr logo](../../assets/icons/reciperr.png){ align=right } - **[Reciperr](../reciperr)** builders grab items based on lists on Reciperr.com + **[Reciperr](reciperr.md)** builders grab items based on lists on Reciperr.com - [:octicons-home-16: View Builder](../reciperr){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](reciperr.md){ .md-button .md-button--primary } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } ??? quicklink "Popular Builders" - - [:material-chef-hat: Reciperr List](../reciperr/#reciperr-list) - Gets every movie returned by the Reciperr JSON data URL. + - [:material-chef-hat: Reciperr List](reciperr.md#reciperr-list) - Gets every movie returned by the Reciperr JSON data URL. !!! builder - ![StevenLu logo](../../../assets/icons/stevenlu.png){ align=right } + ![StevenLu logo](../../assets/icons/stevenlu.png){ align=right } - **[StevenLu](../stevenlu)** builders grab items based on lists on StevenLu.com + **[StevenLu](stevenlu.md)** builders grab items based on lists on StevenLu.com - [:octicons-home-16: View Builder](../stevenlu){ .md-button .md-button--primary } + [:octicons-home-16: View Builder](stevenlu.md){ .md-button .md-button--primary } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } ??? quicklink "Popular Builders" - - [:material-pirate: StevenLu Popular](../stevenlu/#stevenlus-popular-movie-list) - Gets every movie on StevenLu's Popular Movies List. \ No newline at end of file + - [:material-pirate: StevenLu Popular](stevenlu.md#stevenlus-popular-movies-list) - Gets every movie on StevenLu's Popular Movies List. \ No newline at end of file diff --git a/docs/files/collections.md b/docs/files/collections.md index e97460f5..e8eece97 100644 --- a/docs/files/collections.md +++ b/docs/files/collections.md @@ -58,8 +58,8 @@ Collection Files can utilize the following top-level attributes | Attribute | Description | |:--------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------| | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple collections | -| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple collections | -| [`collections`](#collection-operations--attributes) | contains definitions of collections you wish to add to one or more libraries | +| [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple collections | +| [`collections`](#collection-operations-attributes) | contains definitions of collections you wish to add to one or more libraries | | [`dynamic_collections`](#dynamic-collections) | contains definitions of [dynamic collections](dynamic.md) you wish to create | * One of `metadata`, `collections` or `dynamic_collections` must be present for the File to run, else you will receive diff --git a/docs/files/overlays.md b/docs/files/overlays.md index 0391a40b..68b96c8a 100644 --- a/docs/files/overlays.md +++ b/docs/files/overlays.md @@ -67,7 +67,7 @@ Overlay Files can utilize the following top-level attributes | Attribute | Description | |:--------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------| | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple Overlays | -| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays | +| [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays | | [`overlays`](#overlay-attributes) | contains definitions of Overlays you wish to add to one or more libraries | * Example Files can be found in the [Kometa Community Configs Repository](https://github.com/Kometa-Team/Community-Configs) @@ -116,7 +116,7 @@ Overlay Files can utilize the following top-level attributes | Attribute | Description | |:--------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------| | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple overlays | -| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays | +| [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays | | [`queues`](#overlay-queues) | contains the positional attributes of queues | | [`overlays`](#overlay-attributes) | contains definitions of overlays you wish to add | diff --git a/docs/files/playlists.md b/docs/files/playlists.md index 6cad0a94..f63dec26 100644 --- a/docs/files/playlists.md +++ b/docs/files/playlists.md @@ -71,7 +71,7 @@ These are the attributes which can be utilized within the Playlist File: | Attribute | Description | |:--------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------| | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple playlists | -| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple playlists | +| [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple playlists | | [`playlists`](#playlist-attributes) | contains definitions of playlists you wish to add to the server | * `playlists` is required in order to run the Playlist File. diff --git a/docs/kometa/guides/order.md b/docs/kometa/guides/order.md index a5315fba..ef211d17 100644 --- a/docs/kometa/guides/order.md +++ b/docs/kometa/guides/order.md @@ -28,7 +28,7 @@ Let's start with an unmodified set of collections which do **not** specify a cus plex_all: true ``` - ![](images\sorts_example1.png) + ![](images/sorts_example1.png) Now let's use the `sort_title` attribute to reorder these collections slightly @@ -48,7 +48,7 @@ Now let's use the `sort_title` attribute to reorder these collections slightly sort_title: Collection 2 ``` - ![](images\sorts_example2.png) + ![](images/sorts_example2.png) The above could also be achieved using any form of ASCII sort order. This example will produce the same outcome, but uses a (perhaps) illogical set of ASCII characters to define the sort title. @@ -89,7 +89,7 @@ Users aren't expected to understand what this does, but users can use the `colle 1. Because the `!` character is a higher priority ASCII character, that will place ahead of the `000` for the seasonal collections. - ![](images\sorts_example3.jpg) + ![](images/sorts_example3.jpg) You can also re-order collections within each Defaults file using the `order_<>` template variable. <> refers to the identifier that Kometa uses for each collection, which you can find on the relative default's wiki page. @@ -114,7 +114,7 @@ You can also re-order collections within each Defaults file using the `order_< p .md-annotation span span::before { .md-typeset .card-link { color: var(--md-default-fg-color--light); -} \ No newline at end of file +} + +.highlight.no-copy .md-clipboard { display: none; } \ No newline at end of file