From 481e76a61d1fbbf5947d12f895f35d46f33f35e4 Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Wed, 13 Dec 2023 14:30:28 -0500 Subject: [PATCH] [53] doc updates --- VERSION | 2 +- config/config.yml.template | 2 +- docs/builders/files.md | 3 + docs/builders/templates.md | 4 +- docs/config/config.yml.template | 5 ++ docs/config/data/collections.md | 12 ++-- docs/config/data/overlays.md | 24 ++++---- docs/config/data/playlists.md | 10 +-- docs/config/files.md | 42 +------------ docs/config/{paths.md => files_paths.md} | 77 +++++++++++++++++++++--- docs/config/libraries.md | 71 +++++++++++----------- docs/config/playlists.md | 2 +- docs/metadata/metadata.md | 2 +- docs/metadata/overlay.md | 2 +- docs/metadata/playlist.md | 10 +-- docs/metadata/templates.md | 2 +- docs/pmm/install/guides/assets.md | 2 +- docs/stylesheets/extra.css | 22 ++++--- mkdocs.yml | 2 +- 19 files changed, 166 insertions(+), 130 deletions(-) create mode 100644 docs/builders/files.md rename docs/config/{paths.md => files_paths.md} (71%) diff --git a/VERSION b/VERSION index 49f1b46f..05cae49e 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.19.1-develop52 +1.19.1-develop53 diff --git a/config/config.yml.template b/config/config.yml.template index b28df087..7735c9c3 100644 --- a/config/config.yml.template +++ b/config/config.yml.template @@ -37,7 +37,7 @@ settings: - operations - metadata - collections - - operations + - overlays cache: true cache_expiration: 60 asset_directory: config/assets diff --git a/docs/builders/files.md b/docs/builders/files.md new file mode 100644 index 00000000..75e42136 --- /dev/null +++ b/docs/builders/files.md @@ -0,0 +1,3 @@ +{% + include-markdown "../config/files_paths.md" +%} \ No newline at end of file diff --git a/docs/builders/templates.md b/docs/builders/templates.md index 739fcf39..a1e9fbbd 100644 --- a/docs/builders/templates.md +++ b/docs/builders/templates.md @@ -238,8 +238,8 @@ Check out the example files in the [Plex Meta Manager Configs Repository](https: ## External Templates -To load external templates located in another file you can use the `external_templates` attribute by specifying the path type and path of the files that will be executed. See [Path Types](../config/paths.md) for how to define them. - +To load external templates located in another file you can use the `external_templates` attribute by specifying the path type and path of the files that will be executed. See [Path Types](files.md#paths) for how to define them. +[files.md](files.md) ```yaml external_templates: - file: config/templates.yml diff --git a/docs/config/config.yml.template b/docs/config/config.yml.template index 599dd3f8..6a543f72 100644 --- a/docs/config/config.yml.template +++ b/docs/config/config.yml.template @@ -33,6 +33,11 @@ playlist_files: libraries: Movies, TV Shows # list of libraries that you want the PMM Defaults playlists to look at # see the wiki for how to use local files, folders, URLs, or files from git settings: + run_order: + - operations + - metadata + - collections + - overlays cache: true cache_expiration: 60 asset_directory: config/assets diff --git a/docs/config/data/collections.md b/docs/config/data/collections.md index f9e08391..902c1904 100644 --- a/docs/config/data/collections.md +++ b/docs/config/data/collections.md @@ -49,12 +49,12 @@ Whenever I execute Plex Meta Manager and the Movies library is run, MyCollection Collection Files can utilize the following top-level attributes -| Attribute | Description | -|:--------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------| -| [`templates`](../../builders/templates.md) | contains definitions of templates that can be leveraged by multiple collections | -| [`external_templates`](../../builders/templates.md#external-templates) | contains [path types](../paths.md) that point to external templates that can be leveraged by multiple collections | -| [`collections`](#collection-attributes) | contains definitions of collections you wish to add to one or more libraries | -| [`dynamic_collections`](#dynamic-collection-attributes) | contains definitions of [dynamic collections](../../builders/dynamic.md) you wish to create | +| Attribute | Description | +|:--------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------| +| [`templates`](../../builders/templates.md) | contains definitions of templates that can be leveraged by multiple collections | +| [`external_templates`](../../builders/templates.md#external-templates) | contains [path types](../../builders/files.md#paths) that point to external templates that can be leveraged by multiple collections | +| [`collections`](#collection-attributes) | contains definitions of collections you wish to add to one or more libraries | +| [`dynamic_collections`](#dynamic-collection-attributes) | contains definitions of [dynamic collections](../../builders/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 an error when trying to run the file against your library. diff --git a/docs/config/data/overlays.md b/docs/config/data/overlays.md index 87fe290d..4a5d65ce 100644 --- a/docs/config/data/overlays.md +++ b/docs/config/data/overlays.md @@ -78,12 +78,12 @@ Whenever I execute Plex Meta Manager and the Movies library is run, MyOverlays.y Overlay Files can utilize the following top-level attributes -| Attribute | Description | -|:-----------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`templates`](../../builders/templates.md) | contains definitions of templates that can be leveraged by multiple Overlays | -| [`external_templates`](../../builders/templates.md#external-templates) | contains [path types](../paths.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 | - +| Attribute | Description | +|:-----------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------| +| [`templates`](../../builders/templates.md) | contains definitions of templates that can be leveraged by multiple Overlays | +| [`external_templates`](../../builders/templates.md#external-templates) | contains [path types](../../builders/files.md#paths) 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 | +[files.md](..%2F..%2Fbuilders%2Ffiles.md) * Example Files can be found in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) ## Overlay Understandings @@ -127,12 +127,12 @@ To remove all overlays from your library, add `remove_overlays: true` to the `ov Overlay Files can utilize the following top-level attributes -| Attribute | Description | -|:--------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------| -| [`templates`](../../builders/templates.md) | contains definitions of templates that can be leveraged by multiple overlays | -| [`external_templates`](../../builders/templates.md#external-templates) | contains [path types](../paths.md) that point to external templates that can be leveraged by multiple overlays | -| [`queues`](#overlay-queues) | contains the positional attributes of queues | -| [`overlays`](#overlays-attributes) | contains definitions of overlays you wish to add | +| Attribute | Description | +|:--------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------| +| [`templates`](../../builders/templates.md) | contains definitions of templates that can be leveraged by multiple overlays | +| [`external_templates`](../../builders/templates.md#external-templates) | contains [path types](../../builders/files.md#paths) that point to external templates that can be leveraged by multiple overlays | +| [`queues`](#overlay-queues) | contains the positional attributes of queues | +| [`overlays`](#overlays-attributes) | contains definitions of overlays you wish to add | * `overlays` is required in order to run the Overlay File. * Example Overlay Files can be found in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) diff --git a/docs/config/data/playlists.md b/docs/config/data/playlists.md index 21c2e1a0..19be245d 100644 --- a/docs/config/data/playlists.md +++ b/docs/config/data/playlists.md @@ -79,11 +79,11 @@ Plex Meta Manager can automatically build and update playlists defined within th These are the attributes which can be utilized within the Playlist File: -| Attribute | Description | -|:--------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------| -| [`templates`](../../builders/templates.md) | contains definitions of templates that can be leveraged by multiple playlists | -| [`external_templates`](../../builders/templates.md#external-templates) | contains [path types](../paths.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 | +| Attribute | Description | +|:--------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------| +| [`templates`](../../builders/templates.md) | contains definitions of templates that can be leveraged by multiple playlists | +| [`external_templates`](../../builders/templates.md#external-templates) | contains [path types](../../builders/files.md#paths) 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. * You can find example Playlist Files in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) diff --git a/docs/config/files.md b/docs/config/files.md index e924432c..e7c12c30 100644 --- a/docs/config/files.md +++ b/docs/config/files.md @@ -1,39 +1,3 @@ -# Files - -Files define the structure and format for creating Collections, Overlays, Playlists, and Metadata Edits within your libraries. - -Files are modular and when properly leveraged, they not only facilitate the management of your library's collections and metadata but also serve as a crucial backup resource in case a restore is necessary. - -There are four main File types that can be utilized against Plex servers: - -| File Type | Description | -|:-----------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------| -| [Collection Files](data/collections.md) | Defines the data for building collections, allowing you to group and showcase your library in unique ways | -| [Overlay Files](data/overlays.md) | Defines the data for building overlays, allowing you to place information such as resolutions and ratings onto your posters. | -| Metadata Files ([Movies](data/metadata/movie.md)/[Shows](data/metadata/show.md)/[Music](data/metadata/music.md)) | Defines the data for editing metadata, allowing you to find and manipulate the metadata on individual items within your library. | -| [Playlist Files](data/playlists.md) | Defines the data for building playlists, allowing you to combine media from multiple libraries and share them with users on your server | - -Collection, Overlay and Metadata Files can be linked to libraries in the [Libraries Attribute](../config/libraries.md#metadata-path) within the [Configuration File](../config/configuration.md). - -## Example - -This is a basic Files structure showing the use of all four File types. - -???+ example "Example Files" - - Unlike the other three, Playlist Files are not defined per-library. - - Theis examples utilizes the [PMM Defaults](../defaults/files.md) - - ```yaml - libraries: - Movies: - collection_files: - - pmm: imdb - overlay_files: - - pmm: resolution - metadata_files: - - file: config/metadata.yml - playlist_files: - - pmm: playlists - ``` \ No newline at end of file +{% + include-markdown "./files_paths.md" +%} \ No newline at end of file diff --git a/docs/config/paths.md b/docs/config/files_paths.md similarity index 71% rename from docs/config/paths.md rename to docs/config/files_paths.md index 36c7598f..88655c87 100644 --- a/docs/config/paths.md +++ b/docs/config/files_paths.md @@ -1,6 +1,63 @@ -# Path Types +# Files & Paths -YAML Files are defined by their path type and path location for the [`collection_files`](libraries.md#metadata-path), [`overlay_files`](libraries.md#overlay-path), [`playlist_files`](libraries.md#metadata-path), and [`external_templates`](libraries.md#metadata-path) attributes. +When using Plex Meta Manager, the structure of each library is made up of Files and Paths + +???+ example "Example Library Structure" + + ```yaml + libraries: + Movies: + collection_files: + - pmm: imdb + ``` + + In the above example, `collection_files` is the type of File, which tells PMM that the entries that follow will create/update collections and `- pmm:` is the type of Path, which PMM that the file it is looking for is a PMM Defaults file. + + These ideas will be further outlined on this page. + +## Files + +Files define the structure and format for creating Collections, Overlays, Playlists, and Metadata Edits within your libraries. + +Files are modular and when properly leveraged, they not only facilitate the management of your library's collections and metadata but also serve as a crucial backup resource in case a restore is necessary. + +There are four main File types that can be utilized against Plex servers: + +| File Type | Description | +|:-----------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------| +| [Collection Files](data/collections.md) | Defines the data for building collections, allowing you to group and showcase your library in unique ways | +| [Overlay Files](data/overlays.md) | Defines the data for building overlays, allowing you to place information such as resolutions and ratings onto your posters. | +| Metadata Files ([Movies](data/metadata/movie.md)/[Shows](data/metadata/show.md)/[Music](data/metadata/music.md)) | Defines the data for editing metadata, allowing you to find and manipulate the metadata on individual items within your library. | +| [Playlist Files](data/playlists.md) | Defines the data for building playlists, allowing you to combine media from multiple libraries and share them with users on your server | + +Collection, Overlay and Metadata Files can be linked to libraries in the [Libraries Attribute](../config/libraries.md#metadata-path) within the [Configuration File](../config/configuration.md). + +## Example Files + +This is a basic Files structure showing the use of all four File types. + +???+ example "Example Files" + + Unlike the other three, Playlist Files are not defined per-library. + + Theis examples utilizes the [PMM Defaults](../defaults/files.md) + + ```yaml + libraries: + Movies: + collection_files: + - pmm: imdb + overlay_files: + - pmm: resolution + metadata_files: + - file: config/metadata.yml + playlist_files: + - pmm: playlists + ``` + +# Paths + +YAML Files are defined by their path type and path location for the [`collection_files`](libraries.md#metadata-path), [`overlay_files`](libraries.md#overlay-path), [`playlist_files`](libraries.md#metadata-path), and [`external_templates`](#external-templates). They can either be on the local system, online at an url, directly from the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) repository, or from another [`Custom Repository`](settings.md#custom-repo). @@ -10,7 +67,7 @@ The path types are outlined as follows: * `- folder:` refers to a directory containing collection files which is located within the system that PMM is being run from. -* `- pmm:` refers to a [PMM Defaults](/defaults/guide.md builders/overlay/playlist file. +* `- pmm:` refers to a [PMM Defaults](../defaults/files.md) builders/overlay/playlist file. * `- url:` refers to a collection file which is hosted publicly on the internet. @@ -18,8 +75,7 @@ The path types are outlined as follows: * `- repo:` refers to a collection file which is hosted on a custom repository specified by the user with the [`custom_repo` Setting Attribute](settings.md#custom-repo). - -## Examples +## Example Paths ```yaml libraries: @@ -42,6 +98,7 @@ Note that you enter the bits of the items path relative to the top level of the ``` This is assuming the `custom_repo` setting is `https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12` Note that as with `- git:` you enter the bits of the items path relative to repo [`meisnate12/People`] and you don't need the `.yml` extension. +Note that as with `- git:` you enter the bits of the items path relative to repo [`meisnate12/People`] and you don't need the `.yml` extension. ``` - pmm: oscars ``` @@ -123,7 +180,7 @@ playlist_files: ## Collection File -The [`collection_files`](libraries.md#metadata-path) attribute is defined under the [`libraries`](libraries.md) attribute in your [Configuration File](configuration.md. +The [`collection_files`](libraries.md#metadata-path) attribute is defined under the [`libraries`](libraries.md) attribute in your [Configuration File](configuration.md). ??? example @@ -154,7 +211,7 @@ The [`collection_files`](libraries.md#metadata-path) attribute is defined under ## Overlay File -The [`overlay_files`](libraries.md#overlay-path) attribute is defined under the [`libraries`](libraries.md) attribute in your [Configuration File](configuration.md. +The [`overlay_files`](libraries.md#overlay-path) attribute is defined under the [`libraries`](libraries.md) attribute in your [Configuration File](configuration.md). ??? example @@ -185,7 +242,7 @@ The [`overlay_files`](libraries.md#overlay-path) attribute is defined under the ## Playlist Files -The [`playlist_files`](playlists.md) at the top level in your [Configuration File](configuration.md. +The [`playlist_files`](data/playlists.md) at the top level in your [Configuration File](configuration.md). ??? example @@ -214,7 +271,7 @@ The [`playlist_files`](playlists.md) at the top level in your [Configuration Fil ## External Templates -The [`external_templates`](../builders/templates.md#external-templates) attribute is defined at the top level in your [Collection File](../data/collections.md). +The [`external_templates`](../builders/templates.md#external-templates) attribute is defined at the top level in your [Collection File](data/collections.md). ??? example @@ -239,4 +296,4 @@ The [`external_templates`](../builders/templates.md#external-templates) attribut * Then, look in the [defaults folder](https://github.com/meisnate12/Plex-Meta-Manager/tree/master/defaults) within the local PMM folder [or docker container] for a file called `templates.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/defaults/templates.yml). - * Finally, look at the within the Custom Defined Repo for a file called `templates.yml`. + * Finally, look at the within the Custom Defined Repo for a file called `templates.yml`. \ No newline at end of file diff --git a/docs/config/libraries.md b/docs/config/libraries.md index e73a4310..bbe5e4b1 100644 --- a/docs/config/libraries.md +++ b/docs/config/libraries.md @@ -79,21 +79,21 @@ This example is an advanced version of the library mappings which highlights som The available attributes for each library are as follows: -| Attribute | Values | Default | Required | -|:----------------------------------------------------|:------------------------------------------------------------------------------------------------------|:--------------------------------------|:------------------------------------------------------------------:| -| [`library_name`](#library-name) | Library name (required only when trying to use multiple libraries with the same name) | Base Attribute Name | :fontawesome-solid-circle-xmark:{ .red } | -| [`collection_files`](#collection-file) | Location of Collection YAML files | `/config/<>.yml` | :fontawesome-solid-circle-xmark:{ .red } | -| [`overlay_files`](#overlay-file) | Location of Overlay YAML files | None | :fontawesome-solid-circle-xmark:{ .red } | -| [`metadata_files`](#metadata-file) | Location of Metadata YAML files | None | :fontawesome-solid-circle-xmark:{ .red } | -| [`report_path`](#report-path) | Location to create the YAML file listing added, removed, filtered, and missing items for this library | `/config/<>_report.yml` | :fontawesome-solid-circle-xmark:{ .red } | -| [`template_variables`](#library-template-variables) | Library template variables to be applied to every Metadata and Overlay file run. | N/A | :fontawesome-solid-circle-xmark:{ .red } | -| [`schedule`](../builders/details/schedule.md) | Use any [schedule option](../builders/details/schedule.md) to control when this library is run. | daily | :fontawesome-solid-circle-xmark:{ .red } | -| [`operations`](operations.md) | Library Operations to run | N/A | :fontawesome-solid-circle-xmark:{ .red } | -| [`settings`](settings.md) | Any `setting` attribute that overrides a global value | global | :fontawesome-solid-circle-xmark:{ .red } | -| [`plex`](plex.md) | Any `plex` attribute that overrides a global value | global | :fontawesome-solid-circle-check:{ .green } Either here or globally | -| [`radarr`](radarr.md) | Any `radarr` attribute that overrides a global value | global | :fontawesome-solid-circle-xmark:{ .red } | -| [`sonarr`](sonarr.md) | Any `sonarr` attribute that overrides a global value | global | :fontawesome-solid-circle-xmark:{ .red } | -| [`tautulli`](tautulli.md) | Any `tautulli` attribute that overrides a global value | global | :fontawesome-solid-circle-xmark:{ .red } | +| Attribute | Description | +|:----------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`library_name`](#library-name) | Used to specify the Library's name.
*required only when trying to use multiple libraries with the same name.*
**Values:** Library Name
**Default:** Base Attribute Name | +| [`collection_files`](#collection-file) | Used to define [Collection Files](data/collections.md).
**Values:** Location of Collection YAML files.
**Default:** `/config/<>.yml` | +| [`metadata_files`](#metadata-file) | Used to define [Metadata Files](data/collections.md).
**Values:** Location of Metadata YAML files. | +| [`overlay_files`](#overlay-file) | Used to define [Overlay Files](data/overlays.md) .
**Values:** Location of Overlay YAML files. | +| [`report_path`](#report-path) | Location to create the YAML file listing added, removed, filtered, and missing items for this library.
**Values:** Location of the report file.
**Default:** `/config/<>_report.yml` | +| [`template_variables`](#library-template-variables) | Library template variables to be applied to every Collection, Metadata, and Overlay file run.
**Values:** Values are specified by each particular file. | +| [`schedule`](../builders/details/schedule.md) | Used to schedule when this library is run.
**Values:** Any [schedule option](../builders/details/schedule.md)
**Default:** `daily` | +| [`operations`](operations.md) | Used to specify Library Operations to run.
**Values:** Any [Library Operation](operations.md) | +| [`settings`](settings.md) | Used to override global `setting` values for this library only.
**Values:** Any `setting` attribute that overrides a global value.
**Default:** global value | +| [`plex`](plex.md) | Used to override global `plex` values for this library only. **`plex` Attribute is required either here or globally**
**Values:** Any `plex` attribute that overrides a global value.
**Default:** global value | +| [`radarr`](radarr.md) | Used to override global `radarr` values for this library only.
**Values:** Any `radarr` attribute that overrides a global value.
**Default:** global value | +| [`sonarr`](sonarr.md) | Used to override global `sonarr` values for this library only.
**Values:** Any `sonarr` attribute that overrides a global value.
**Default:** global value | +| [`tautulli`](tautulli.md) | Used to override global `tautulli` values for this library only.
**Values:** Any `tautulli` attribute that overrides a global value.
**Default:** global value | ### Library Name @@ -117,11 +117,11 @@ Each library that the user wants Plex Meta Manager to interact with must be docu token: #################### ``` - * In this example, `"Movies01"`, `"TV Shows"`, and `"Anime"` will all use the global plex server (http://192.168.1.12:32400) which is defined using the global `plex` mapping. `"Movies02"` will use the plex server http://192.168.1.35:32400 which is defined under its `plex` mapping over the global mapping. + * In this example, `"Movies01"`, `"TV Shows"`, and `"Anime"` will all use the global plex server (**http://192.168.1.12:32400**) which is defined using the global `plex` mapping. `"Movies02"` will use the plex server **http://192.168.1.35:32400** which is defined under its `plex` mapping over the global mapping. ### Collection File -The `collection_files` attribute is used to define [Collection Files](data/collections.md) by specifying the path type and path of the files that will be executed against the parent library. See [Path Types](paths.md) for how to define them. +The `collection_files` attribute is used to define [Collection Files](data/collections.md) by specifying the path type and path of the files that will be executed against the parent library. See [Path Types](../builders/files.md#paths) for how to define them. ```yaml libraries: @@ -139,9 +139,27 @@ libraries: TV Shows: ``` +### Metadata File + +The `metadata_files` attribute is used to define Metadata Files by specifying the path of the files that will be executed against the parent library. See [Path Types](../builders/files.md#paths) for how to define them. + +???+ tip + + As of Plex Meta Manager 1.20.0 "Metadata Files" refers to YAML files which refers to managing the metadata of items [movies, shows, music] within your library, and "Collection Files" refers to YAML files which define Collections. + + In previous version of Plex Meta Manager, "Metadata Files" could mean either of the above. + + +```yaml +libraries: + TV Shows: + metadata_files: + - file: config/metadata.yml +``` + ### Overlay File -The `overlay_files` attribute is used to define [Overlay Files](data/overlays.md) by specifying the path type and path of the files that will be executed against the parent library. See [Path Types](paths.md) for how to define them. +The `overlay_files` attribute is used to define [Overlay Files](data/overlays.md) by specifying the path type and path of the files that will be executed against the parent library. See [Path Types](../builders/files.md#paths) for how to define them. ```yaml libraries: @@ -228,23 +246,6 @@ You cannot schedule individual Overlay Files, as any unscheduled overlay file wi - file: config/Overlays.yml ``` -### Metadata File - -The `metadata_files` attribute is used to define Metadata Files by specifying the path of the files that will be executed against the parent library. See [Path Types](paths.md) for how to define them. - -???+ tip - - As of Plex Meta Manager 1.19.2 "Metadata Files" refers to YAML files which refers to managing the metadata of items [movies, shows, music] within your library, and "Collection Files" refers to YAML files which define Collections. - - In previous version of Plex Meta Manager, "Metadata Files" could mean either of the above. - - -```yaml -libraries: - TV Shows: - metadata_files: - - file: config/metadata.yml -``` ### Report Path The `report_path` attribute is used to define where to save the YAML Report file. This file is used to store information about what media is added, removed, filtered, and missing from the Plex library compared to what is expected from the Metadata file. diff --git a/docs/config/playlists.md b/docs/config/playlists.md index d1a2243f..3bd9e7f6 100644 --- a/docs/config/playlists.md +++ b/docs/config/playlists.md @@ -2,7 +2,7 @@ As playlists are not tied to one specific library and can combine media from multiple libraries, they require their own special [Playlist Files](data/playlists.md) to work. -Within the [Config File](configuration.md, the `playlist_files` attribute specifies the [path type](paths.md) and path of the [Playlist Files](data/playlists.md) that the user wants Plex Meta Manager to act on. +Within the [Config File](configuration.md, the `playlist_files` attribute specifies the [path type](../builders/files.md#paths) and path of the [Playlist Files](data/playlists.md) that the user wants Plex Meta Manager to act on. **The libraries used in the playlist attribute `libraries` must be defined under the `libraries` attribute of the [Config File](configuration.md.** diff --git a/docs/metadata/metadata.md b/docs/metadata/metadata.md index c5d1892d..5c1c1b6e 100644 --- a/docs/metadata/metadata.md +++ b/docs/metadata/metadata.md @@ -11,7 +11,7 @@ These are the attributes which can be used within the Metadata File: | Attribute | Description | |:--------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple collections | -| [`external_templates`](templates.md#external-templates) | contains [path types](../config/paths.md) that point to external templates that can be leveraged by multiple collections | +| [`external_templates`](templates.md#external-templates) | contains [path types](../builders/files.md#paths) that point to external templates that can be leveraged by multiple collections | | [`collections`](#collection-attributes) | contains definitions of collections you wish to add to one or more libraries | | [`dynamic_collections`](#dynamic-collection-attributes) | contains definitions of [dynamic collections](dynamic.md) you wish to create | | [`metadata`](#metadata-attributes) | contains definitions of metadata changes to [movie](metadata/movie.md), [show](metadata/show.md), or [music](metadata/music.md) library's items [movie titles, episode descriptions, etc.] | diff --git a/docs/metadata/overlay.md b/docs/metadata/overlay.md index e30b2cc0..2b7dfec9 100644 --- a/docs/metadata/overlay.md +++ b/docs/metadata/overlay.md @@ -67,7 +67,7 @@ These are the attributes which can be used within the Overlay File: | Attribute | Description | |:--------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------| | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple overlays | -| [`external_templates`](templates.md#external-templates) | contains [path types](../config/paths.md) that point to external templates that can be leveraged by multiple overlays | +| [`external_templates`](templates.md#external-templates) | contains [path types](../builders/files.md#paths) that point to external templates that can be leveraged by multiple overlays | | [`queues`](#overlay-queues) | contains the positional attributes of queues | | [`overlays`](#overlays-attributes) | contains definitions of overlays you wish to add | diff --git a/docs/metadata/playlist.md b/docs/metadata/playlist.md index 909f8894..6b5fef9f 100644 --- a/docs/metadata/playlist.md +++ b/docs/metadata/playlist.md @@ -79,11 +79,11 @@ Plex Meta Manager can automatically build and update playlists defined within th 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 [path types](../config/paths.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 | +| Attribute | Description | +|:----------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------| +| [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple playlists | +| [`external_templates`](templates.md#external-templates) | contains [path types](../builders/files.md#paths) 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. * You can find example Playlist Files in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) diff --git a/docs/metadata/templates.md b/docs/metadata/templates.md index 502e741c..6cb573d6 100644 --- a/docs/metadata/templates.md +++ b/docs/metadata/templates.md @@ -238,7 +238,7 @@ Check out the example files in the [Plex Meta Manager Configs Repository](https: ## External Templates -To load external templates located in another file you can use the `external_templates` attribute by specifying the path type and path of the files that will be executed. See [Path Types](../config/paths.md) for how to define them. +To load external templates located in another file you can use the `external_templates` attribute by specifying the path type and path of the files that will be executed. See [Path Types](../builders/files.md#paths) for how to define them. ```yaml external_templates: diff --git a/docs/pmm/install/guides/assets.md b/docs/pmm/install/guides/assets.md index 8430fe75..c8f3054f 100644 --- a/docs/pmm/install/guides/assets.md +++ b/docs/pmm/install/guides/assets.md @@ -30,7 +30,7 @@ settings: - config/assets_ahoy ``` -* You can specify an Image Asset Directory per Metadata/Playlist/Overlay File when calling the file. See [Path Types](../../../config/paths.md#asset-directory) for how to define them. +* You can specify an Image Asset Directory per Metadata/Playlist/Overlay File when calling the file. See [Path Types](../../../builders/files.md#paths) for how to define them. * By default [if no `asset_directory` is specified], the program will look in the same folder as your `config.yml` for a folder called `assets`. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 320e749d..16545e53 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -99,21 +99,24 @@ .orange { color: #e69800; } - table.clearTable { - margin-top: 5px; - margin-bottom: 5px; + display: inline !important; } table.clearTable td { - padding: 3px 3px 3px 15px; + padding: 3px 15px 3px 3px !important; +} +table.clearTable td:last-child { + padding: 3px 3px 3px 3px !important; } table.clearTable th { - text-align: center; + text-align: center !important; } 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; + background-color: transparent !important; + border: 0 !important; + /* 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; @@ -152,6 +155,9 @@ table.dualTable td, table.dualTable th { overflow: auto; touch-action: auto; } +.md-typeset table:not([class]) th { + min-width: 0rem; +} /* dark mode alternating table bg colors */ [data-md-color-scheme="slate"] .md-typeset__table tr:nth-child(2n) { background-color: #1b1b1b; diff --git a/mkdocs.yml b/mkdocs.yml index 96edfb93..0f3209ab 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -140,7 +140,6 @@ nav: - Overlay Files: config/files.md - Metadata Files: config/files.md - Playlist Files: config/files.md - - Path Types: config/paths.md - Library Operations: config/operations.md - Settings: config/settings.md - Webhooks: config/webhooks.md @@ -263,6 +262,7 @@ nav: - PLAYLIST DEFAULTS: - Playlists: defaults/playlist.md - FILES & BUILDERS: + - Overview: builders/files.md - "FILES": - Collection Files: config/data/collections.md - Overlay Files: config/data/overlays.md