From 8fbcf49afde1fe3c5f4db6cb12d8ab09bfc5f186 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Fri, 5 Jan 2024 21:55:28 +0000 Subject: [PATCH 1/4] add wording of `delete_collections` less attribute being optional, fix incorrect Attribute names, and fix typos --- docs/config/operations.md | 6 +++--- docs/defaults/overlays/aspect.md | 2 +- docs/defaults/overlays/audio_codec.md | 2 +- docs/defaults/overlays/commonsense.md | 2 +- docs/defaults/overlays/content_rating_de.md | 2 +- docs/defaults/overlays/content_rating_uk.md | 2 +- docs/defaults/overlays/content_rating_us_movie.md | 2 +- docs/defaults/overlays/content_rating_us_show.md | 2 +- docs/defaults/overlays/direct_play.md | 2 +- docs/defaults/overlays/episode_info.md | 2 +- docs/defaults/overlays/flixpatrol.md | 2 +- docs/defaults/overlays/language_count.md | 2 +- docs/defaults/overlays/languages.md | 2 +- docs/defaults/overlays/mediastinger.md | 2 +- docs/defaults/overlays/network.md | 2 +- docs/defaults/overlays/ratings.md | 2 +- docs/defaults/overlays/resolution.md | 2 +- docs/defaults/overlays/ribbon.md | 2 +- docs/defaults/overlays/runtimes.md | 2 +- docs/defaults/overlays/status.md | 2 +- docs/defaults/overlays/streaming.md | 2 +- docs/defaults/overlays/studio.md | 2 +- docs/defaults/overlays/versions.md | 2 +- docs/defaults/overlays/video_format.md | 2 +- 24 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/config/operations.md b/docs/config/operations.md index 6b099f19..bce8f314 100644 --- a/docs/config/operations.md +++ b/docs/config/operations.md @@ -69,7 +69,7 @@ You can create individual blocks of operations by using a list under `operations
- **Attribute:** `assets_for_all` + **Attribute:** `delete_collections` **Accepted Values:** There are a few different options to determine how the `delete_collections` works. @@ -78,7 +78,7 @@ You can create individual blocks of operations by using a list under `operations `managed: false`Collection must be Unmanaged to be deleted
(collection does not have the `PMM` label) `configured: true`Collection must be Configured to be deleted
(collection is in the config file of the specific PMM run) `configured: false`Collection must be Unconfigured to be deleted
(collection is not in the config file of the specific PMM run) - `less: ###`Collection must contain less then the given number of items to be deleted.
### is a Number greater than 0 + `less: ###`Collection must contain less then the given number of items to be deleted.
### is a Number greater than 0
Optional value which if undefined means collections will be deleted regardless of how many items they have **The collection does not need to be scheduled to be considered configured and only needs to be in the config file.** @@ -410,7 +410,7 @@ You can create individual blocks of operations by using a list under `operations
- **Attribute:** `mass_poster_update` + **Attribute:** `mass_background_update` **Accepted Values:** diff --git a/docs/defaults/overlays/aspect.md b/docs/defaults/overlays/aspect.md index b2eb27a5..cfedfc8b 100644 --- a/docs/defaults/overlays/aspect.md +++ b/docs/defaults/overlays/aspect.md @@ -49,7 +49,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/audio_codec.md b/docs/defaults/overlays/audio_codec.md index 053765fe..e34bb258 100644 --- a/docs/defaults/overlays/audio_codec.md +++ b/docs/defaults/overlays/audio_codec.md @@ -65,7 +65,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/commonsense.md b/docs/defaults/overlays/commonsense.md index df88738a..0e2fd1b8 100644 --- a/docs/defaults/overlays/commonsense.md +++ b/docs/defaults/overlays/commonsense.md @@ -62,7 +62,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/content_rating_de.md b/docs/defaults/overlays/content_rating_de.md index f1c86070..2c2b3d06 100644 --- a/docs/defaults/overlays/content_rating_de.md +++ b/docs/defaults/overlays/content_rating_de.md @@ -50,7 +50,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:---------| diff --git a/docs/defaults/overlays/content_rating_uk.md b/docs/defaults/overlays/content_rating_uk.md index ec84460d..b64b4154 100644 --- a/docs/defaults/overlays/content_rating_uk.md +++ b/docs/defaults/overlays/content_rating_uk.md @@ -51,7 +51,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:---------| diff --git a/docs/defaults/overlays/content_rating_us_movie.md b/docs/defaults/overlays/content_rating_us_movie.md index e04b8605..f1a78713 100644 --- a/docs/defaults/overlays/content_rating_us_movie.md +++ b/docs/defaults/overlays/content_rating_us_movie.md @@ -40,7 +40,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:---------| diff --git a/docs/defaults/overlays/content_rating_us_show.md b/docs/defaults/overlays/content_rating_us_show.md index 6c0b3874..0b97cb27 100644 --- a/docs/defaults/overlays/content_rating_us_show.md +++ b/docs/defaults/overlays/content_rating_us_show.md @@ -46,7 +46,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:---------| diff --git a/docs/defaults/overlays/direct_play.md b/docs/defaults/overlays/direct_play.md index fff71702..1f95e28d 100644 --- a/docs/defaults/overlays/direct_play.md +++ b/docs/defaults/overlays/direct_play.md @@ -30,7 +30,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/episode_info.md b/docs/defaults/overlays/episode_info.md index e12e0834..32da6d5e 100644 --- a/docs/defaults/overlays/episode_info.md +++ b/docs/defaults/overlays/episode_info.md @@ -27,7 +27,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/flixpatrol.md b/docs/defaults/overlays/flixpatrol.md index 80e9d00b..487825ee 100644 --- a/docs/defaults/overlays/flixpatrol.md +++ b/docs/defaults/overlays/flixpatrol.md @@ -42,7 +42,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------------| diff --git a/docs/defaults/overlays/language_count.md b/docs/defaults/overlays/language_count.md index 6c9c913c..535a4f22 100644 --- a/docs/defaults/overlays/language_count.md +++ b/docs/defaults/overlays/language_count.md @@ -43,7 +43,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/languages.md b/docs/defaults/overlays/languages.md index 0806fc9b..2bd9b793 100644 --- a/docs/defaults/overlays/languages.md +++ b/docs/defaults/overlays/languages.md @@ -126,7 +126,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:-----------------------------| diff --git a/docs/defaults/overlays/mediastinger.md b/docs/defaults/overlays/mediastinger.md index 8199e5a1..c694d6a3 100644 --- a/docs/defaults/overlays/mediastinger.md +++ b/docs/defaults/overlays/mediastinger.md @@ -27,7 +27,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/network.md b/docs/defaults/overlays/network.md index d687ce9c..91017b51 100644 --- a/docs/defaults/overlays/network.md +++ b/docs/defaults/overlays/network.md @@ -39,7 +39,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/ratings.md b/docs/defaults/overlays/ratings.md index b694ab91..41d57ea3 100644 --- a/docs/defaults/overlays/ratings.md +++ b/docs/defaults/overlays/ratings.md @@ -68,7 +68,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/resolution.md b/docs/defaults/overlays/resolution.md index 6c2026f4..f5094b65 100644 --- a/docs/defaults/overlays/resolution.md +++ b/docs/defaults/overlays/resolution.md @@ -118,7 +118,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/ribbon.md b/docs/defaults/overlays/ribbon.md index 20212158..decb4ab3 100644 --- a/docs/defaults/overlays/ribbon.md +++ b/docs/defaults/overlays/ribbon.md @@ -53,7 +53,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:---------| diff --git a/docs/defaults/overlays/runtimes.md b/docs/defaults/overlays/runtimes.md index cd9cca8f..f2b90b18 100644 --- a/docs/defaults/overlays/runtimes.md +++ b/docs/defaults/overlays/runtimes.md @@ -33,7 +33,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/status.md b/docs/defaults/overlays/status.md index ea547c6e..0c10a9e3 100644 --- a/docs/defaults/overlays/status.md +++ b/docs/defaults/overlays/status.md @@ -36,7 +36,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/streaming.md b/docs/defaults/overlays/streaming.md index bf810b40..9b612f5a 100644 --- a/docs/defaults/overlays/streaming.md +++ b/docs/defaults/overlays/streaming.md @@ -55,7 +55,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:-------------------------------------------------------------------------------| diff --git a/docs/defaults/overlays/studio.md b/docs/defaults/overlays/studio.md index de31345e..174c767e 100644 --- a/docs/defaults/overlays/studio.md +++ b/docs/defaults/overlays/studio.md @@ -30,7 +30,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| diff --git a/docs/defaults/overlays/versions.md b/docs/defaults/overlays/versions.md index 569f4e60..055ed249 100644 --- a/docs/defaults/overlays/versions.md +++ b/docs/defaults/overlays/versions.md @@ -36,7 +36,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:-----------------| diff --git a/docs/defaults/overlays/video_format.md b/docs/defaults/overlays/video_format.md index 9d820cf7..272a988e 100644 --- a/docs/defaults/overlays/video_format.md +++ b/docs/defaults/overlays/video_format.md @@ -49,7 +49,7 @@ Note that the `template_variables:` section only needs to be used if you do want ??? info "Click to expand" - ??? example "Default Templatye Variable Values (click to expand)" + ??? example "Default Template Variable Values (click to expand)" | Variable | Default | |:--------------------|:------------| From c81a4fb134c921b094421364e00ed5dc6a56fb26 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Fri, 5 Jan 2024 22:34:24 +0000 Subject: [PATCH 2/4] less and more "then" should be less and more "than" --- docs/config/operations.md | 2 +- docs/files/builders/anilist.md | 4 ++-- docs/files/builders/imdb.md | 8 ++++---- docs/files/builders/myanimelist.md | 6 +++--- docs/files/builders/trakt.md | 2 +- docs/files/dynamic_types.md | 4 ++-- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/config/operations.md b/docs/config/operations.md index bce8f314..75be16bc 100644 --- a/docs/config/operations.md +++ b/docs/config/operations.md @@ -78,7 +78,7 @@ You can create individual blocks of operations by using a list under `operations `managed: false`Collection must be Unmanaged to be deleted
(collection does not have the `PMM` label) `configured: true`Collection must be Configured to be deleted
(collection is in the config file of the specific PMM run) `configured: false`Collection must be Unconfigured to be deleted
(collection is not in the config file of the specific PMM run) - `less: ###`Collection must contain less then the given number of items to be deleted.
### is a Number greater than 0
Optional value which if undefined means collections will be deleted regardless of how many items they have + `less: ###`Collection must contain less than the given number of items to be deleted.
### is a Number greater than 0
Optional value which if undefined means collections will be deleted regardless of how many items they have **The collection does not need to be scheduled to be considered configured and only needs to be in the config file.** diff --git a/docs/files/builders/anilist.md b/docs/files/builders/anilist.md index 8654aa4f..b84f4329 100644 --- a/docs/files/builders/anilist.md +++ b/docs/files/builders/anilist.md @@ -113,8 +113,8 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin | `list_name` | **Description:** A user's AniList List Name | | `score.gt`1 | **Description:** Only return items that have a score greater than the given number.
**Values:** `0.0`-`10.0` | | `score.gte`1 | **Description:** Only return items that have a score greater than or equal to the given number.
**Values:** `0.0`-`10.0` | -| `score.lt`1 | **Description:** Only return items that have a score less then the given number.
**Values:** `0.0`-`10.0` | -| `score.lte`1 | **Description:** Only return items that have a score less then or equal to the given number.
**Values:** `0.0`-`10.0` | +| `score.lt`1 | **Description:** Only return items that have a score less than the given number.
**Values:** `0.0`-`10.0` | +| `score.lte`1 | **Description:** Only return items that have a score less than or equal to the given number.
**Values:** `0.0`-`10.0` | | `sort_by` | **Description:** Sort Order to return
**Default:** `score`
**Values:**
`score`Sort by User Score
`popularity`Sort by Popularity
`status`Sort by Status
`progress`Sort by Progress
`last_updated`Sort by Last Updated
`last_added`Sort by Last Added
`start_date`Sort by Start Date
`completed_date`Sort by Completed Date
| 1 You can use multiple score filters but the number will have to match every filter. All unrated items are considered to have a 0 rating. diff --git a/docs/files/builders/imdb.md b/docs/files/builders/imdb.md index bd4e401e..51c9322b 100644 --- a/docs/files/builders/imdb.md +++ b/docs/files/builders/imdb.md @@ -192,9 +192,9 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin | `release.after` | Item must have been released after the given date.
**Options:** `today` or Date in the format `YYYY-MM-DD` | | `release.before` | Item must have been released before the given date.
**Options:** `today` or Date in the format `YYYY-MM-DD` | | `rating.gte` | Item must have an IMDb Rating greater then or equal to the given number.
**Options:** Any Number `0.1` - `10.0`
**Example:** `7.5` | -| `rating.lte` | Item must have an IMDb Rating less then or equal to the given number.
**Options:** Any Number `0.1` - `10.0`
**Example:** `7.5` | +| `rating.lte` | Item must have an IMDb Rating less than or equal to the given number.
**Options:** Any Number `0.1` - `10.0`
**Example:** `7.5` | | `votes.gte` | Item must have a Number of Votes greater then or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | -| `votes.lte` | Item must have a Number of Votes less then or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | +| `votes.lte` | Item must have a Number of Votes less than or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | | `genre` | Item must match all genres given. Can be a comma-separated list.
**Options:** `action`, `adventure`, `animation`, `biography`, `comedy`, `documentary`, `drama`, `crime`, `family`, `history`, `news`, `short`, `western`, `sport`, `reality-tv`, `horror`, `fantasy`, `film-noir`, `music`, `romance`, `talk-show`, `thriller`, `war`, `sci-fi`, `musical`, `mystery`, `game-show` | | `genre.any` | Item must match at least one given genre. Can be a comma-separated list.
**Options:** `action`, `adventure`, `animation`, `biography`, `comedy`, `documentary`, `drama`, `crime`, `family`, `history`, `news`, `short`, `western`, `sport`, `reality-tv`, `horror`, `fantasy`, `film-noir`, `music`, `romance`, `talk-show`, `thriller`, `war`, `sci-fi`, `musical`, `mystery`, `game-show` | | `genre.not` | Item must not match any og the given genres. Can be a comma-separated list.
**Options:** `action`, `adventure`, `animation`, `biography`, `comedy`, `documentary`, `drama`, `crime`, `family`, `history`, `news`, `short`, `western`, `sport`, `reality-tv`, `horror`, `fantasy`, `film-noir`, `music`, `romance`, `talk-show`, `thriller`, `war`, `sci-fi`, `musical`, `mystery`, `game-show` | @@ -221,12 +221,12 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin | `language.not` | Item must not match any given language. Can be a comma-separated list.
**Options:** [ISO 639-2 Language Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `language.primary` | Item must match any given language as the primary language. Can be a comma-separated list.
**Options:** [ISO 639-2 Language Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `popularity.gte` | Item must have a Popularity greater then or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | -| `popularity.lte` | Item must have a Popularity less then or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | +| `popularity.lte` | Item must have a Popularity less than or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | | `cast` | Item must have all the given cast members. Can be a comma-separated list.
**Options:** Any IMDb Person ID (ex. `nm0000138`) | | `cast.any` | Item must have any of the given cast members. Can be a comma-separated list.
**Options:** Any IMDb Person ID (ex. `nm0000138`) | | `cast.not` | Item must not have any of the given cast members. Can be a comma-separated list.
**Options:** Any IMDb Person ID (ex. `nm0000138`) | | `runtime.gte` | Item must have a Runtime greater then or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | -| `runtime.lte` | Item must have a Runtime less then or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | +| `runtime.lte` | Item must have a Runtime less than or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | | `adult` | Include adult titles in the search results.
**Options:** `true`/`false` | ### Examples diff --git a/docs/files/builders/myanimelist.md b/docs/files/builders/myanimelist.md index 7f56439c..fcd0a588 100644 --- a/docs/files/builders/myanimelist.md +++ b/docs/files/builders/myanimelist.md @@ -30,7 +30,7 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin | Attribute | Description | |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `sort_by` | **Description:** Sort Order to return
**Values:** `mal_id.desc`, `mal_id.asc`, `title.desc`, `title.asc`, `type.desc`, `type.asc`, `rating.desc`, `rating.asc`, `start_date.desc`, `start_date.asc`, `end_date.desc`, `end_date.asc`, `episodes.desc`, `episodes.asc`, `score.desc`, `score.asc`, `scored_by.desc`, `scored_by.asc`, `rank.desc`, `rank.asc`, `popularity.desc`, `popularity.asc`, `members.desc`, `members.asc`, `favorites.desc`, `favorites.asc` | -| `limit` | **Description:** Don't return more then this number
**Values:** Number of Anime to query from MyAnimeList | +| `limit` | **Description:** Don't return more than this number
**Values:** Number of Anime to query from MyAnimeList | | `query` | **Description:** Text query to search for | | `prefix` | **Description:** Results must begin with this prefix | | `type` | **Description:** Type of Anime to search for
**Values:** `tv`, `movie`, `ova`, `special`, `ona`, `music` | @@ -242,7 +242,7 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin | `username` | **Description:** A user's MyAnimeList Username or `@me` for the authorized user | | `status` | **Description:** Status to search for
**Default:** `all`
**Values:**
`all`All Anime List
`watching`Currently Watching List
`completed`Completed List
`on_hold`On Hold List
`dropped`Dropped List
`plan_to_watch`Plan to Watch
| | `sort_by` | **Description:** Sort Order to return
**Default:** `score`
**Values:**
`score`Sort by Score
`last_updated`Sort by Last Updated
`title`Sort by Anime Title
`start_date`Sort by Start Date
| -| `limit` | **Description:** Don't return more then this number
**Default:** `100`
**Values:** Number of Anime to query from MyAnimeList (max: 1000) | +| `limit` | **Description:** Don't return more than this number
**Default:** `100`
**Values:** Number of Anime to query from MyAnimeList (max: 1000) | ```yaml collections: @@ -267,7 +267,7 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin | `season` | **Description:** Season to search
**Default:** `current`
**Values:**
`winter`For winter season January, February, March
`spring`For spring season April, May, June
`summer`For summer season July, August, September
`fall`For fall season October, November, December
`current`For the current Season
| | `year` | **Description:** Year to search
**Default:** Current Year
**Values:** Number between `1917` and the current year. | | `sort_by` | **Description:** Sort Order
**Default:** `members`
**Values:**
`members`Sort by Most Members
`score`Sort by Score
| -| `limit` | **Description:** Don't return more then this number
**Default:** `100`
**Values:** Number of Anime to query from MyAnimeList (max: 500) | +| `limit` | **Description:** Don't return more than this number
**Default:** `100`
**Values:** Number of Anime to query from MyAnimeList (max: 500) | | `starting_only` | **Description:** Return only anime that began airing in the selected season
**Default:** `False`
**Values:** `True` or `False` | ```yaml diff --git a/docs/files/builders/trakt.md b/docs/files/builders/trakt.md index f2aa3103..f170fe89 100644 --- a/docs/files/builders/trakt.md +++ b/docs/files/builders/trakt.md @@ -68,7 +68,7 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin |:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `chart` | **Description:** Which Trakt chart to query
**Values:**
`trending`Trakt's Trending [Movies](https://trakt.tv/movies/trending)/[Shows](https://trakt.tv/shows/trending) list
`popular`Trakt's Popular [Movies](https://trakt.tv/movies/popular)/[Shows](https://trakt.tv/shows/popular) list
`recommended`Trakt's Recommended [Movies](https://trakt.tv/movies/recommended)/[Shows](https://trakt.tv/shows/recommended) list
`watched`Trakt's Watched [Movies](https://trakt.tv/movies/watched)/[Shows](https://trakt.tv/shows/watched) list
`collected`Trakt's Collected [Movies](https://trakt.tv/movies/collected)/[Shows](https://trakt.tv/shows/collected) list
| | `time_period` | **Description:** Time Period for the chart. Does not work with `trending` or `popular` chart types.
**Default:** `weekly`
**Values:** `daily`, `weekly`, `monthly`, `yearly`, or `all` | -| `limit` | **Description:** Don't return more then this number
**Default:** `10`
**Values:** Number of Items to query. | +| `limit` | **Description:** Don't return more than this number
**Default:** `10`
**Values:** Number of Items to query. | | `query` | **Description:** Search titles and descriptions for this
**Values:** Any String. | | `years` | **Description:** Search for the specified years only
**Values:** 4 digit year or range of 4 digit years. i.e. `1950` or `1950-1959` | | `genres` | **Description:** Search for the specified genres only
**Values:** Comma separated string or list of genres
**Movie Genres:** `action`, `adventure`, `animation`, `anime`, `comedy`, `crime`, `documentary`, `drama`, `family`, `fantasy`, `history`, `holiday`, `horror`, `music`, `musical`, `mystery`, `none`, `romance`, `science-fiction`, `short`, `sporting-event`, `superhero`, `suspense`, `thriller`, `war`, `western`
**Show Genres:** `action`, `adventure`, `animation`, `anime`, `biography`, `children`, `comedy`, `crime`, `documentary`, `drama`, `family`, `fantasy`, `game-show`, `history`, `holiday`, `home-and-garden`, `horror`, `mini-series`, `music`, `musical`, `mystery`, `news`, `none`, `reality`, `romance`, `science-fiction`, `short`, `soap`, `special-interest`, `sporting-event`, `superhero`, `suspense`, `talk-show`, `thriller`, `war`, `western` | diff --git a/docs/files/dynamic_types.md b/docs/files/dynamic_types.md index 5825dd71..03941054 100644 --- a/docs/files/dynamic_types.md +++ b/docs/files/dynamic_types.md @@ -193,9 +193,9 @@ requirements of creating the collection. **Valid Library Types:** Movies and Shows - **Key Values:** Award Year (sometimes this will look like `2003-2` if there are more then one award show that year) + **Key Values:** Award Year (sometimes this will look like `2003-2` if there are more than one award show that year) - **Key Name Value:** Award Year (sometimes this will look like `2003-2` if there are more then one award show that + **Key Name Value:** Award Year (sometimes this will look like `2003-2` if there are more than one award show that year) **Default `title_format`:** `<>` From 09cebec2177a6c6be5c499d20a72c6126e80c53e Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Sat, 6 Jan 2024 00:35:57 +0000 Subject: [PATCH 3/4] fix more "then"s --- docs/files/builders/imdb.md | 20 ++++++++++---------- docs/pmm/faqs.md | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/files/builders/imdb.md b/docs/files/builders/imdb.md index 51c9322b..c9a876c0 100644 --- a/docs/files/builders/imdb.md +++ b/docs/files/builders/imdb.md @@ -184,24 +184,24 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin | Search Parameter | Description | |:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | Specify how items you want returned by the query.
**Options:** Any Integer greater then `0`
**Default:** `100` | +| `limit` | Specify how items you want returned by the query.
**Options:** Any Integer greater than `0`
**Default:** `100` | | `sort_by` | Choose from one of the many available sort options.
**Options:** `popularity.asc`, `popularity.desc`, `title.asc`, `title.desc`, `rating.asc`, `rating.desc`, `votes.asc`, `votes.desc`, `box_office.asc`, `box_office.desc`, `runtime.asc`, `runtime.desc`, `year.asc`, `year.desc`, `release.asc`, `release.desc`
**Default:** `popularity.asc` | | `title` | Search by title name.
**Options:** Any String | | `type` | Item must match at least one given type. Can be a comma-separated list.
**Options:** `movie`, `tv_series`, `short`, `tv_episode`, `tv_mini_series`, `tv_movie`, `tv_special`, `tv_short`, `video_game`, `video`, `music_video`, `podcast_series`, `podcast_episode` | | `type.not` | Item must not match any of the given types. Can be a comma-separated list.
**Options:** `movie`, `tv_series`, `short`, `tv_episode`, `tv_mini_series`, `tv_movie`, `tv_special`, `tv_short`, `video_game`, `video`, `music_video`, `podcast_series`, `podcast_episode` | | `release.after` | Item must have been released after the given date.
**Options:** `today` or Date in the format `YYYY-MM-DD` | | `release.before` | Item must have been released before the given date.
**Options:** `today` or Date in the format `YYYY-MM-DD` | -| `rating.gte` | Item must have an IMDb Rating greater then or equal to the given number.
**Options:** Any Number `0.1` - `10.0`
**Example:** `7.5` | +| `rating.gte` | Item must have an IMDb Rating greater than or equal to the given number.
**Options:** Any Number `0.1` - `10.0`
**Example:** `7.5` | | `rating.lte` | Item must have an IMDb Rating less than or equal to the given number.
**Options:** Any Number `0.1` - `10.0`
**Example:** `7.5` | -| `votes.gte` | Item must have a Number of Votes greater then or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | -| `votes.lte` | Item must have a Number of Votes less than or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | +| `votes.gte` | Item must have a Number of Votes greater than or equal to the given number.
**Options:** Any Integer greater than `0`
**Example:** `1000` | +| `votes.lte` | Item must have a Number of Votes less than or equal to the given number.
**Options:** Any Integer greater than `0`
**Example:** `1000` | | `genre` | Item must match all genres given. Can be a comma-separated list.
**Options:** `action`, `adventure`, `animation`, `biography`, `comedy`, `documentary`, `drama`, `crime`, `family`, `history`, `news`, `short`, `western`, `sport`, `reality-tv`, `horror`, `fantasy`, `film-noir`, `music`, `romance`, `talk-show`, `thriller`, `war`, `sci-fi`, `musical`, `mystery`, `game-show` | | `genre.any` | Item must match at least one given genre. Can be a comma-separated list.
**Options:** `action`, `adventure`, `animation`, `biography`, `comedy`, `documentary`, `drama`, `crime`, `family`, `history`, `news`, `short`, `western`, `sport`, `reality-tv`, `horror`, `fantasy`, `film-noir`, `music`, `romance`, `talk-show`, `thriller`, `war`, `sci-fi`, `musical`, `mystery`, `game-show` | | `genre.not` | Item must not match any og the given genres. Can be a comma-separated list.
**Options:** `action`, `adventure`, `animation`, `biography`, `comedy`, `documentary`, `drama`, `crime`, `family`, `history`, `news`, `short`, `western`, `sport`, `reality-tv`, `horror`, `fantasy`, `film-noir`, `music`, `romance`, `talk-show`, `thriller`, `war`, `sci-fi`, `musical`, `mystery`, `game-show` | | `event` | Item must have been nominated for a category at the event given. Can be a comma-separated list.
**Options:** `cannes`, `choice`, `spirit`, `sundance`, `bafta`, `oscar`, `emmy`, `golden`, `oscar_picture`, `oscar_director`, `national_film_board_preserved`, `razzie`, or any [IMDb Event ID](https://www.imdb.com/event/all/) (ex. `ev0050888`) | | `event.winning` | Item must have won a category at the event given. Can be a comma-separated list.
**Options:** `cannes`, `choice`, `spirit`, `sundance`, `bafta`, `oscar`, `emmy`, `golden`, `oscar_picture`, `oscar_director`, `national_film_board_preserved`, `razzie`, or any [IMDb Event ID](https://www.imdb.com/event/all/) (ex. `ev0050888`) | -| `imdb_top` | Item must be in the top number of given Movies.
**Options:** Any Integer greater then `0` | -| `imdb_bottom` | Item must be in the bottom number of given Movies.
**Options:** Any Integer greater then `0` | +| `imdb_top` | Item must be in the top number of given Movies.
**Options:** Any Integer greater than `0` | +| `imdb_bottom` | Item must be in the bottom number of given Movies.
**Options:** Any Integer greater than `0` | | `company` | Item must have been released by any company given. Can be a comma-separated list.
**Options:** `fox`, `dreamworks`, `mgm`, `paramount`, `sony`, `universal`, `disney`, `warner`, or any IMDb Company ID (ex. `co0023400`) | | `content_rating` | Item must have the given content rating. Can be a list.
**Options:** Dictionary with two attributes `rating` and `region`
`rating`: Any String to match the content rating
`region`: [2 Digit ISO 3166 Country Code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | | `country` | Item must match with every given country. Can be a comma-separated list.
**Options:** [2 Digit ISO 3166 Country Code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | @@ -220,13 +220,13 @@ The `sync_mode: sync` and `collection_order: custom` Setting are recommended sin | `language.any` | Item must match at least one given language. Can be a comma-separated list.
**Options:** [ISO 639-2 Language Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `language.not` | Item must not match any given language. Can be a comma-separated list.
**Options:** [ISO 639-2 Language Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `language.primary` | Item must match any given language as the primary language. Can be a comma-separated list.
**Options:** [ISO 639-2 Language Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | -| `popularity.gte` | Item must have a Popularity greater then or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | -| `popularity.lte` | Item must have a Popularity less than or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | +| `popularity.gte` | Item must have a Popularity greater than or equal to the given number.
**Options:** Any Integer greater than `0`
**Example:** `1000` | +| `popularity.lte` | Item must have a Popularity less than or equal to the given number.
**Options:** Any Integer greater than `0`
**Example:** `1000` | | `cast` | Item must have all the given cast members. Can be a comma-separated list.
**Options:** Any IMDb Person ID (ex. `nm0000138`) | | `cast.any` | Item must have any of the given cast members. Can be a comma-separated list.
**Options:** Any IMDb Person ID (ex. `nm0000138`) | | `cast.not` | Item must not have any of the given cast members. Can be a comma-separated list.
**Options:** Any IMDb Person ID (ex. `nm0000138`) | -| `runtime.gte` | Item must have a Runtime greater then or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | -| `runtime.lte` | Item must have a Runtime less than or equal to the given number.
**Options:** Any Integer greater then `0`
**Example:** `1000` | +| `runtime.gte` | Item must have a Runtime greater than or equal to the given number.
**Options:** Any Integer greater than `0`
**Example:** `1000` | +| `runtime.lte` | Item must have a Runtime less than or equal to the given number.
**Options:** Any Integer greater than `0`
**Example:** `1000` | | `adult` | Include adult titles in the search results.
**Options:** `true`/`false` | ### Examples diff --git a/docs/pmm/faqs.md b/docs/pmm/faqs.md index bd0ed484..46a16654 100644 --- a/docs/pmm/faqs.md +++ b/docs/pmm/faqs.md @@ -368,7 +368,7 @@ Your PMM installation may not be located at the paths referenced below. These a There could be any number of reasons why this happens and it depends on what server PMM is talking to although its most likely coming from your Plex Server. - Most of the time these errors need to be resolved by changing something specific to your set up but some do come up that can be fixed (i.e. Plex throws one if you upload a photo larger then 10 MB) + Most of the time these errors need to be resolved by changing something specific to your set up but some do come up that can be fixed (i.e. Plex throws one if you upload a photo larger than 10 MB) Many Appbox Setups will throw this error when too many requests are sent, or if the central metadata repository is not properly configured to allow users to upload custom posters. From f789591b2fe3fe5b6947caa3b6339133516cee48 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Sat, 6 Jan 2024 01:00:03 +0000 Subject: [PATCH 4/4] replace uses of `current_year` and `current` with `latest` --- docs/defaults/award/bafta.md | 2 +- docs/defaults/award/cannes.md | 2 +- docs/defaults/award/choice.md | 6 +++--- docs/defaults/award/emmy.md | 6 +++--- docs/defaults/award/golden.md | 6 +++--- docs/defaults/award/oscars.md | 6 +++--- docs/defaults/award/spirit.md | 6 +++--- docs/defaults/award/sundance.md | 6 +++--- docs/defaults/collections.md | 4 ++-- docs/defaults/example.md | 36 ++++++++++++++++----------------- docs/files/dynamic_types.md | 4 ++-- 11 files changed, 42 insertions(+), 42 deletions(-) diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index a6ac6745..2d4b00ee 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -53,7 +53,7 @@ work. Any value not specified will use its default value if it has one if not it | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**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
| | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `BAFTA <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<> BAFTA Awards.`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index c6533c72..a321ae77 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -50,7 +50,7 @@ Note that the `template_variables:` section only needs to be used if you do want | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**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
| | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Cannes <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<> Cannes Awards.`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index 785e4546..1d9fbb64 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -53,7 +53,7 @@ Note that the `template_variables:` section only needs to be used if you do want | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**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
| | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Critics Choice <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<> Critics Choice Awards.`
**Values:** Any string with `<>` in it. | @@ -90,8 +90,8 @@ Note that the `template_variables:` section only needs to be used if you do want radarr_add_missing: true #(3)! name_format: Critics Choice Awards <> Winners #(4)! data: - starting: current_year-10 #(5)! - ending: current_year #(6)! + starting: latest-10 #(5)! + ending: latest #(6)! ``` 1. Shows the collection and all of its items within the Library tab in Plex diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index ce06ba54..bb73c894 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -50,7 +50,7 @@ Note that the `template_variables:` section only needs to be used if you do want | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**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
| | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Emmys <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<> Emmy Winners.`
**Values:** Any string with `<>` in it. | @@ -86,8 +86,8 @@ Note that the `template_variables:` section only needs to be used if you do want radarr_add_missing: true #(3)! name_format: Emmys <> Winners #(4)! data: - starting: current_year-10 #(5)! - ending: current_year #(6)! + starting: latest-10 #(5)! + ending: latest #(6)! ``` 1. Shows the collection and all of its items within the Library tab in Plex diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index 759cb725..747843ac 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -54,7 +54,7 @@ Note that the `template_variables:` section only needs to be used if you do want | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**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
| | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Golden Globe <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<> Golden Globe Winners.`
**Values:** Any string with `<>` in it. | @@ -90,8 +90,8 @@ Note that the `template_variables:` section only needs to be used if you do want radarr_add_missing: true #(3)! name_format: Emmys <> Winners #(4)! data: - starting: current_year-10 #(5)! - ending: current_year #(6)! + starting: latest-10 #(5)! + ending: latest #(6)! ``` 1. Shows the collection and all of its items within the Library tab in Plex diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index 53ae3f85..71b3546b 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -49,7 +49,7 @@ Note that the `template_variables:` section only needs to be used if you do want | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**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
| | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-6
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year-1
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-6
Values: Number greater than 0
endingControls the ending year for collections
Default: latest-1
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Oscars Winners <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Academy Awards (Oscars) Winners for <>.`
**Values:** Any string with `<>` in it. | @@ -86,8 +86,8 @@ Note that the `template_variables:` section only needs to be used if you do want radarr_add_missing: true #(3)! name_format: Emmys <> Winners #(4)! data: - starting: current_year-10 #(5)! - ending: current_year #(6)! + starting: latest-10 #(5)! + ending: latest #(6)! ``` 1. Shows the collection and all of its items within the Library tab in Plex diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index b092c404..c456a19e 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -50,7 +50,7 @@ Note that the `template_variables:` section only needs to be used if you do want | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**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
| | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Independent Spirit Awards <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<> Independent Spirit Awards.`
**Values:** Any string with `<>` in it. | @@ -86,8 +86,8 @@ Note that the `template_variables:` section only needs to be used if you do want radarr_add_missing: true #(3)! name_format: Independent Spirit Awards <> Winners #(4)! data: - starting: current_year-10 #(5)! - ending: current_year #(6)! + starting: latest-10 #(5)! + ending: latest #(6)! ``` 1. Shows the collection and all of its items within the Library tab in Plex diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index 47987232..b2c492a7 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -50,7 +50,7 @@ Note that the `template_variables:` section only needs to be used if you do want | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**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
| | `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| + | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Sundance Film Festival <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Sundance Film Festival of <>.`
**Values:** Any string with `<>` in it. | @@ -87,8 +87,8 @@ Note that the `template_variables:` section only needs to be used if you do want radarr_add_missing: true #(3)! name_format: Sundance Film Festival <> Winners #(4)! data: - starting: current_year-10 #(5)! - ending: current_year #(6)! + starting: latest-10 #(5)! + ending: latest #(6)! ``` 1. Shows the collection and all of its items within the Library tab in Plex diff --git a/docs/defaults/collections.md b/docs/defaults/collections.md index 7a0b21a1..39463d63 100644 --- a/docs/defaults/collections.md +++ b/docs/defaults/collections.md @@ -135,8 +135,8 @@ libraries: template_variables: radarr_add_missing: true data: - starting: current_year-10 - ending: current_year + starting: latest-10 + ending: latest ``` Or maybe you want to change the number of actor collections made using pmm: actor. diff --git a/docs/defaults/example.md b/docs/defaults/example.md index cc7d7fbd..0902321d 100644 --- a/docs/defaults/example.md +++ b/docs/defaults/example.md @@ -13,20 +13,20 @@ collection_files: - pmm: separator_award # An "index card" - pmm: bafta # BAFTA Awards - template_variables: # Show collections from current_year-10 onwards. + template_variables: # Show collections from latest-10 onwards. data: - starting: current_year-10 - ending: current_year + starting: latest-10 + ending: latest - pmm: golden # Golden Globes Awards - template_variables: # Show collections from current_year-10 onwards. + template_variables: # Show collections from latest-10 onwards. data: - starting: current_year-10 - ending: current_year + starting: latest-10 + ending: latest - pmm: oscars # The Oscars - template_variables: # Show collections from current_year-10 onwards. + template_variables: # Show collections from latest-10 onwards. data: - starting: current_year-10 - ending: current_year + starting: latest-10 + ending: latest - pmm: separator_chart # An "index card" - pmm: basic # Some basic chart collections - pmm: tmdb # TMDb Charts (Popular, Trending, etc.) @@ -73,20 +73,20 @@ collection_files: - pmm: separator_award # An "index card" - pmm: bafta # BAFTA Awards - template_variables: # Show collections from current_year-10 onwards. + template_variables: # Show collections from latest-10 onwards. data: - starting: current_year-10 - ending: current_year + starting: latest-10 + ending: latest - pmm: golden # Golden Globes Awards - template_variables: # Show collections from current_year-10 onwards. + template_variables: # Show collections from latest-10 onwards. data: - starting: current_year-10 - ending: current_year + starting: latest-10 + ending: latest - pmm: oscars # The Oscars - template_variables: # Show collections from current_year-10 onwards. + template_variables: # Show collections from latest-10 onwards. data: - starting: current_year-10 - ending: current_year + starting: latest-10 + ending: latest - pmm: separator_chart # An "index card" - pmm: basic # Some basic chart collections - pmm: tmdb # TMDb Charts (Popular, Trending, etc.) diff --git a/docs/files/dynamic_types.md b/docs/files/dynamic_types.md index 03941054..4e46c9d9 100644 --- a/docs/files/dynamic_types.md +++ b/docs/files/dynamic_types.md @@ -218,8 +218,8 @@ requirements of creating the collection. type: imdb_awards data: event_id: ev0000003 - starting: current-15 - ending: current + starting: latest-15 + ending: latest ``` ??? blank "`trakt_user_lists` - Collections based on Trakt Lists by users.ΒΆ"