Update docs

pull/1799/head
Arial-Z 11 months ago
parent 11fe2e2fef
commit 72cbddeacb

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 452 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 452 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 401 KiB

@ -2,7 +2,7 @@
The `network` Default Overlay File is used to create an overlay based on the show network on each item within your library.
![](images/network.png)
![](images/Network_color.png)
## Requirements & Recommendations
@ -39,17 +39,21 @@ Note that the `template_variables:` section only needs to be used if you do want
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
| Variable | Default / Values |
|:--------------------|:-----------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `510` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Default / Values |
|:--------------------|:-------------------------------------------------------------------------------------------------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `510` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| `style` | **Description:** Choose between the default color version or the **white** one.<br>**Values:** `white` |
Preview of the white style
![](images/Network_white.png)
=== "Overlay Template Variables"
@ -68,6 +72,7 @@ Note that the `template_variables:` section only needs to be used if you do want
overlay_files:
- pmm: network
template_variables:
style: white
vertical_offset: 390
- pmm: network
template_variables:

@ -2,7 +2,7 @@
The `network` Default Collection File is used to dynamically create collections based on the networks available in your library.
![](../images/network.png)
![](../images/network_color.png)
## Requirements & Recommendations
@ -48,6 +48,8 @@ Note that the `template_variables:` section only needs to be used if you do want
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
| `style` | **Description:** Choose between the default color version or the **white** one.<br>**Values:** `white`
|
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Networks found in your library |
| `exclude` | **Description:** Exclude these Networks from creating a Dynamic Collection.<br>**Values:** List of Networks found in your library |
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Networks found in your library |
@ -58,6 +60,10 @@ Note that the `template_variables:` section only needs to be used if you do want
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s broadcast on <<key_name>>.`<br>**Values:** Any string. |
Preview of the white style
![](../images/Network_white.png)
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
=== "Shared Template Variables"
@ -84,6 +90,7 @@ Note that the `template_variables:` section only needs to be used if you do want
collection_files:
- pmm: network
template_variables:
style: white
append_exclude:
- BBC #(1)!
sort_by: title.asc
@ -288,6 +295,7 @@ Note that the `template_variables:` section only needs to be used if you do want
- Space
- Spectrum
- Spike
- Stöð 2
- Stan
- Starz
- STAR+

Loading…
Cancel
Save