From fbdfde84f91eff155e85a9388085f67b5f7dab7d Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Thu, 3 Nov 2022 16:50:13 -0400 Subject: [PATCH] [185] update yaml --- VERSION | 2 +- docs/home/guides/yaml.md | 30 +++++++++++++++--------------- docs/metadata/builders.md | 36 ++++++++++++++++++------------------ 3 files changed, 34 insertions(+), 34 deletions(-) diff --git a/VERSION b/VERSION index dd464e3d..b8cfdb36 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.3-develop184 +1.17.3-develop185 diff --git a/docs/home/guides/yaml.md b/docs/home/guides/yaml.md index 1c8ff3c9..45e518f3 100644 --- a/docs/home/guides/yaml.md +++ b/docs/home/guides/yaml.md @@ -4,7 +4,7 @@ All of Plex Meta Manager's Config, Metadata, Overlay, and Playlist Files are wri This tutorial will help you understand the specific parts of the files. -## Example YAML File We're working with +## Example YAML File ```yaml libraries: @@ -116,15 +116,15 @@ The "keys" are `cache` and `cache_expiration` and the "values" are `true` and `6 you can represent a dictionary on a single line by using `{` and `}` ```yaml -settings: - cache: true - cache_expiration: 60 +settings: {cache: true, cache_expiration: 60} ``` is equivalent to ```yaml -settings: {cache: true, cache_expiration: 60} +settings: + cache: true + cache_expiration: 60 ``` ## Lists @@ -141,20 +141,20 @@ The first item in the list is `config/movie assets` and the second is `config/tv ### In-Line Lists -you can represent a dictionary on a single line by using `{` and `}` +you can represent a dictionary on a single line by using `[` and `]` ```yaml settings: - asset_directory: - - config/movie assets - - config/tv assets + asset_directory: [config/movie assets, config/tv assets] ``` is equivalent to ```yaml settings: - asset_directory: [config/movie assets, config/tv assets] + asset_directory: + - config/movie assets + - config/tv assets ``` ## Literals @@ -180,8 +180,8 @@ There are many occurrences of these special characters where quotes are not need ```yaml message1: YAML & JSON # breaks as a & is a special character message2: "YAML & JSON" # Works as the string is quoted -message3: YAML: Let's Get Started # breaks as a : is a special character -message4: "YAML: Let's Get Started" # Works as the string is quoted +message: 3: YAML # breaks as a : is a special character +"message: 3": YAML # Works as the key string is quoted ``` #### Multiline Strings @@ -208,7 +208,7 @@ libraries: # Value is a Dictionary with keys `Movies` and Everything after `#` on a line is ignored. -## Anchors and Alias +## Anchors and Aliases With a lot of configuration, configuration files can become quite large. @@ -242,7 +242,7 @@ Anchors (`&`) are used to define a chunk of configuration, and aliases (`*`) are ```yaml libraries: Movies: - metadata_path: &metadata_path # Anchor called metadata_path + metadata_path: &paths # Anchor called `paths` - pmm: basic - pmm: imdb overlay_path: @@ -251,7 +251,7 @@ libraries: use_metacritic: false use_common: false TV Shows: - metadata_path: *metadata_path # Alias to call the above section + metadata_path: *paths # Alias to call the above `paths` section overlay_path: - pmm: ribbon ``` \ No newline at end of file diff --git a/docs/metadata/builders.md b/docs/metadata/builders.md index ebdffc8c..30db4f86 100644 --- a/docs/metadata/builders.md +++ b/docs/metadata/builders.md @@ -4,21 +4,21 @@ Builders use third-party services to source items to be added to the collection. | Name | Description | Requires Config | |:--------------------------------------|:----------------------------------------------------------------------------------------------|:---------------:| -| [Plex](builders/plex) | Grabs items based on the metadata inside your Plex Server. | ❌ | -| [Smart](builders/smart) | Creates Smart Collections based on the metadata inside your Plex Server. (Collections Only) | ❌ | -| [TMDb](builders/tmdb) | Grabs items based on metadata and lists on [TheMovieDb.org](https://www.themoviedb.org/). | ❌ | -| [TVDb](builders/tvdb) | Grabs items based on metadata and lists on [TheTVDb.com](https://www.thetvdb.com/). | ✅ | -| [IMDb](builders/imdb) | Grabs items based on metadata and lists on [IMDb.com](https://www.imdb.com/). | ✅ | -| [Trakt](builders/trakt) | Grabs items based on metadata and lists on [Trakt.tv](https://trakt.tv/). | ❌ | -| [Tautulli](builders/tautulli) | Grabs items based on metadata and lists in your [Tautulli](https://tautulli.com/). | ❌ | -| [Radarr](builders/radarr) | Grabs items based on metadata and lists in your [Radarr](https://radarr.video/) . | ❌ | -| [Sonarr](builders/sonarr) | Grabs items based on metadata and lists in your [Sonarr](https://sonarr.tv/). | ❌ | -| [MdbList](builders/mdblist) | Grabs items based on metadata and lists on [MdbList.com](https://mdblist.com/). | ✅ | -| [Letterboxd](builders/letterboxd) | Grabs items based on metadata and lists on [Letterboxd.com](https://letterboxd.com/). | ✅ | -| [ICheckMovies](builders/icheckmovies) | Grabs items based on metadata and lists on [ICheckMovies.com](https://www.icheckmovies.com/). | ✅ | -| [FlixPatrol](builders/flixpatrol) | Grabs items based on metadata and lists on [FlixPatrol.com](https://flixpatrol.com/). | ✅ | -| [Reciperr](builders/reciperr) | Grabs items based on metadata and lists on [reciperr.com](https://reciperr.com/). | ✅ | -| [StevenLu](builders/stevenlu) | Grabs items based on metadata and lists on [StevenLu.com](https://movies.stevenlu.com/). | ✅ | -| [AniDB](builders/anidb) | Grabs items based on metadata and lists on [AniDB.net](https://anidb.net/). | ✅ | -| [AniList](builders/anilist) | Grabs items based on metadata and lists on [AniList.co](https://anilist.co/). | ✅ | -| [MyAnimeList](builders/myanimelist) | Grabs items based on metadata and lists on [MyAnimeList.net](https://myanimelist.net/). | ❌ | \ No newline at end of file +| [Plex](builders/plex) | Grabs items based on the metadata inside your Plex Server. | ✅ | +| [Smart](builders/smart) | Creates Smart Collections based on the metadata inside your Plex Server. (Collections Only) | ✅ | +| [TMDb](builders/tmdb) | Grabs items based on metadata and lists on [TheMovieDb.org](https://www.themoviedb.org/). | ✅ | +| [TVDb](builders/tvdb) | Grabs items based on metadata and lists on [TheTVDb.com](https://www.thetvdb.com/). | ❌ | +| [IMDb](builders/imdb) | Grabs items based on metadata and lists on [IMDb.com](https://www.imdb.com/). | ❌ | +| [Trakt](builders/trakt) | Grabs items based on metadata and lists on [Trakt.tv](https://trakt.tv/). | ✅ | +| [Tautulli](builders/tautulli) | Grabs items based on metadata and lists in your [Tautulli](https://tautulli.com/). | ✅ | +| [Radarr](builders/radarr) | Grabs items based on metadata and lists in your [Radarr](https://radarr.video/) . | ✅ | +| [Sonarr](builders/sonarr) | Grabs items based on metadata and lists in your [Sonarr](https://sonarr.tv/). | ✅ | +| [MdbList](builders/mdblist) | Grabs items based on metadata and lists on [MdbList.com](https://mdblist.com/). | ❌ | +| [Letterboxd](builders/letterboxd) | Grabs items based on metadata and lists on [Letterboxd.com](https://letterboxd.com/). | ❌ | +| [ICheckMovies](builders/icheckmovies) | Grabs items based on metadata and lists on [ICheckMovies.com](https://www.icheckmovies.com/). | ❌ | +| [FlixPatrol](builders/flixpatrol) | Grabs items based on metadata and lists on [FlixPatrol.com](https://flixpatrol.com/). | ❌ | +| [Reciperr](builders/reciperr) | Grabs items based on metadata and lists on [reciperr.com](https://reciperr.com/). | ❌ | +| [StevenLu](builders/stevenlu) | Grabs items based on metadata and lists on [StevenLu.com](https://movies.stevenlu.com/). | ❌ | +| [AniDB](builders/anidb) | Grabs items based on metadata and lists on [AniDB.net](https://anidb.net/). | ❌ | +| [AniList](builders/anilist) | Grabs items based on metadata and lists on [AniList.co](https://anilist.co/). | ❌ | +| [MyAnimeList](builders/myanimelist) | Grabs items based on metadata and lists on [MyAnimeList.net](https://myanimelist.net/). | ✅ | \ No newline at end of file