From fc540f00c5bd2ea09f96e56aa924baecb1229152 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Thu, 9 Nov 2023 00:10:53 +0000 Subject: [PATCH] fix some lists spacing and add clear/dualtable CSS --- docs/builders/plex.md | 1 + docs/builders/tmdb.md | 2 ++ docs/config/myanimelist.md | 1 + docs/config/settings.md | 32 ++++++++++++++++++++++++++++++++ docs/stylesheets/extra.css | 22 ++++++++++++++++++++++ 5 files changed, 58 insertions(+) diff --git a/docs/builders/plex.md b/docs/builders/plex.md index 99c60b06..49285a9b 100644 --- a/docs/builders/plex.md +++ b/docs/builders/plex.md @@ -77,6 +77,7 @@ To combat the problem above you set all collections to `Hide items in this colle With the variability of collections generated by the Plex Meta Manager maintaining a collection like this becomes very difficult, so in order to automate it, you can use `plex_collectionless`. You just have to tell it what collections to exclude or what collection prefixes to exclude. There are two attributes for `plex_collectionless`: + * `exclude`: Exclude these Collections from being considered for collectionless. * `exclude_prefix` Exclude Collections whose title or sort title starts with a prefix from being considered for collectionless. diff --git a/docs/builders/tmdb.md b/docs/builders/tmdb.md index f097fd10..8fd08697 100644 --- a/docs/builders/tmdb.md +++ b/docs/builders/tmdb.md @@ -49,6 +49,7 @@ You can find items using the features of [TheMovieDb.org](https://www.themoviedb ## Expected Input The builders below are expected to have the full URL to the item or the TMDb ID of the item. Multiple values are supported as either a list or a comma-separated string. + * [TMDb Collection](#tmdb-collection) and [TMDb Collection Details](#tmdb-collection) * [TMDb List](#tmdb-list) and [TMDb List Details](#tmdb-list) * [TMDb Actor](#tmdb-actor) and [TMDb Actor Details](#tmdb-actor) @@ -62,6 +63,7 @@ The builders below are expected to have the full URL to the item or the TMDb ID * [TMDb Network](#tmdb-network) The builders below are expected to have a single integer value of how many movies/shows to query. + * [TMDb Popular](#tmdb-popular) * [TMDb Now Playing](#tmdb-now-playing) * [TMDb Top Rated](#tmdb-top-rated) diff --git a/docs/config/myanimelist.md b/docs/config/myanimelist.md index 8219f590..3428d11c 100644 --- a/docs/config/myanimelist.md +++ b/docs/config/myanimelist.md @@ -26,6 +26,7 @@ mal: * All other attributes will be filled in by Plex Meta Manager. * To connect to MyAnimeList.net you must create a MyAnimeList application and supply Plex Meta Manager the `client id` and `client secret` provided, please do the following: + 1. [Click here to create a MyAnimeList API application.](https://myanimelist.net/apiconfig/create) 2. Enter an `App Name` for the application. Ex. `Plex Meta Manager` 3. Select `web` for `App Type`. diff --git a/docs/config/settings.md b/docs/config/settings.md index e3da5ed0..b1f1d130 100644 --- a/docs/config/settings.md +++ b/docs/config/settings.md @@ -8,6 +8,7 @@ search: The `settings:` attribute and subsequent settings can be used to command various aspects of the functionality of Plex Meta Manager. Examples of these settings include the ability to: + * Cache each Plex GUID and IDs to increase performance * Create asset folders for collections so that custom posters can be stored for upload. * Use a custom repository as the base for all `git` Metadata files. @@ -123,10 +124,12 @@ i.e. `assets/Star Wars/poster.png` instead of `assets/Star Wars.png` ## Asset Depth + Specify how many folder levels to scan for an item within the asset directory
At each asset level, PMM will look for either `medianame.ext` [such as Star Wars.png] or a dedicated folder containing `poster.ext`
i.e. `assets/Star Wars/poster.png` and `assets/Star Wars.png` are both asset depth 0 and `assets/Movies/Star Wars/poster.png` and `assets/Movies/Star Wars.png` are both asset level 1 + * `asset_folders` must be set to `true` for this to take effect. * increasing the amount of levels to scan will reduce performance @@ -146,6 +149,7 @@ and `assets/Movies/Star Wars/poster.png` and `assets/Movies/Star Wars.png` are b Whilst searching for assets, if an asset folder cannot be found within the `asset_directory` one will be created. Asset Searches can happen in a number of ways. + * Any Collection specified under the `collections` header in a Metadata File. * Any Item specified under the `metadata` header in a Metadata File. * Any Playlist specified under the `playlists` header in a Playlist File. @@ -258,6 +262,7 @@ Whilst searching for assets, show or hide the `update not needed` messages. ## Sync Mode Set the default `sync_mode` for collections. + * `sync` will add and remove any items that are added/removed from the source builder * `append` will only add items that are added from the source builder, but will not remove anything even if it is removed from the source builder. @@ -274,7 +279,9 @@ Set the default `sync_mode` for collections. ## Default Collection Order + Set the default `collection_order` for every collection run by PMM. + * `custom` cannot be used if more than one builder is being used for the collection (such as `imdb_list` and `trakt_list` within the same collection) @@ -309,7 +316,9 @@ Set the minimum number of items that must be found in order to build or update a
## Delete Below Minimum + When a collection is run, delete the collection if it is below the minimum number specified by `minimum_items`. + * Relies on `minimum_items` being set to the desired integer. @@ -340,8 +349,11 @@ If a collection is skipped due to it not being scheduled, delete the collection.
## Run Again Delay + Set the number of minutes to delay running `run_again` collections after daily run is finished. + For example, if a collection adds items to Sonarr/Radarr, the library can automatically re-run "X" amount of time later so that any downloaded items are processed. + * A collection is a `run_again` collection if it has the `run_again` [Setting Detail](../builders/details/definition.md) attribute set to true. @@ -356,6 +368,7 @@ For example, if a collection adds items to Sonarr/Radarr, the library can automa
## Missing Only Released + Whilst running a collection, all unreleased missing items will be filtered out from the [missing YAML file](../builders/details/definition.md) @@ -371,6 +384,7 @@ Whilst running a collection, all unreleased missing items will be filtered out f
## Show Unmanaged Collections + List all collections not managed by Plex Meta Manager at the end of each run. @@ -433,7 +447,9 @@ While `show_missing` is true items missing from collections will be displayed.
## Only Filter Missing + Only items missing from a collection will be filtered. **Only specific filters can filter missing. See [Filters](../metadata/filters.md) for more information.** + * this can be used to filter which missing media items get sent to Sonarr/Radarr @@ -479,7 +495,9 @@ Save a report of the items added, removed, filtered, or missing from collections
## TVDb Language + Specify the language to query TVDb in. + * If no language is specified or the specified language is not found then the original language is used. @@ -496,7 +514,9 @@ Specify the language to query TVDb in. 1 Language Codes can be found [here](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) ## Ignore IDs + Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collections. + * this does not apply to `smart_filter` Collections
@@ -511,7 +531,9 @@ Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collectio
## Ignore IMDb IDs + Set a list or comma-separated string of IMDb IDs to ignore in all collections. + * this does not apply to `smart_filter` Collections @@ -526,7 +548,9 @@ Set a list or comma-separated string of IMDb IDs to ignore in all collections.
## Item Refresh Delay + Specify the amount of time to wait between each `item_refresh` of every movie/show in a collection/playlist. + * Useful if your Plex Media Server is having issues with high request levels. @@ -541,7 +565,9 @@ Specify the amount of time to wait between each `item_refresh` of every movie/sh
## Playlist Sync to Users + Set the default playlist `sync_to_users`. To Sync a playlist to only yourself leave `playlist_sync_to_users` blank. + * sharing playlists with other users will not share any posters associated with the playlist, this is a Plex limitation. @@ -582,7 +608,9 @@ Set `playlist_report` to true to print out a playlist report at the end of the l
## Custom Repo + Specify where the `repo` attribute's base is when defining `metadata_path`, `playlist_file` and `overlay_path`. + * Ensure you are using the raw GitHub link (i.e. https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12 ) @@ -597,7 +625,9 @@ Specify where the `repo` attribute's base is when defining `metadata_path`, `pla
## Verify SSL + Turn SSL Verification on or off. + * set to false if your log file shows any errors similar to "SSL: CERTIFICATE_VERIFY_FAILED" @@ -612,7 +642,9 @@ Turn SSL Verification on or off.
## Check Nightly + Will check nightly for updates instead of develop. + * This does not affect which version of PMM is grabbed when using `git pull` or any other update mechanism, it is only used for the initial version check when PMM runs to specify if a new version is available. * It is recommended to set this to `true` if you primarily use the `nightly` branch diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index f862b995..b97870ba 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -101,6 +101,28 @@ color: #e69800; } +table.clearTable { + margin-top: 5px; + margin-bottom: 5px; +} +table.clearTable td { + padding: 3px 3px 3px 15px; +} +table.clearTable th { + text-align: center; +} +table.clearTable, table.clearTable tbody, table.clearTable tr, table.clearTable td, table.clearTable th { + background-color: var(--md-default-bg-color); + border: 0.05rem solid var(--md-typeset-table-color); + border-radius: 0.1rem; +} +table.dualTable td, table.dualTable th { + padding-left: 15px !important; + background-color: var(--md-default-bg-color); + border: 0.05rem solid var(--md-typeset-table-color); + border-radius: 0.1rem; +} + [data-md-color-scheme="slate"] .grey { color: #414454; }