Merge pull request #2045 from Kometa-Team/doc-updates

add note on MDBList not being live reflection of third-party sources
This commit is contained in:
YozoraXCII 2024-05-15 13:13:43 +01:00 committed by GitHub
commit ed69f35cd4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 38 additions and 9 deletions

View file

@ -157,6 +157,10 @@ You can create individual blocks of operations by using a list under `operations
**Accepted Values:** Source or List of sources to use in that order
???+ tip "Note on `mdb` sources"
MDBList is not a live reflection of third-party sites such as CommonSense and Trakt. The data on MDBList is often days, weeks and months out of date as it is only periodically refreshed. As such, the data that Kometa applies using `mdb_` operations applies may not be the same as you see if you visit those third-party sources directly.
<table class="clearTable">
<tr><td>`mdb`</td><td>Use MDBList for Content Ratings</td></tr>
<tr><td>`mdb_commonsense`</td><td>Use Common Sense Rating through MDBList for Content Ratings</td></tr>
@ -274,7 +278,11 @@ You can create individual blocks of operations by using a list under `operations
**Attribute:** `mass_originally_available_update`
**Accepted Values:** Source or List of sources to use in that order
???+ tip "Note on `mdb` sources"
MDBList is not a live reflection of third-party sites such as CommonSense and Trakt. The data on MDBList is often days, weeks and months out of date as it is only periodically refreshed. As such, the data that Kometa applies using `mdb_` operations applies may not be the same as you see if you visit those third-party sources directly.
<table class="clearTable">
<tr><td>`tmdb`</td><td>Use TMDb Release Date</td></tr>
<tr><td>`tvdb`</td><td>Use TVDb Release Date</td></tr>
@ -313,7 +321,11 @@ You can create individual blocks of operations by using a list under `operations
**Attribute:** `mass_added_at_update`
**Accepted Values:** Source or List of sources to use in that order
???+ tip "Note on `mdb` sources"
MDBList is not a live reflection of third-party sites such as CommonSense and Trakt. The data on MDBList is often days, weeks and months out of date as it is only periodically refreshed. As such, the data that Kometa applies using `mdb_` operations applies may not be the same as you see if you visit those third-party sources directly.
<table class="clearTable">
<tr><td>`tmdb`</td><td>Use TMDb Release Date</td></tr>
<tr><td>`tvdb`</td><td>Use TVDb Release Date</td></tr>
@ -363,7 +375,11 @@ You can create individual blocks of operations by using a list under `operations
**Attribute:** `mass_audience_rating_update`/`mass_critic_rating_update`/`mass_user_rating_update`
**Accepted Values:** Source or List of sources to use in that order
???+ tip "Note on `mdb` sources"
MDBList is not a live reflection of third-party sites such as CommonSense and Trakt. The data on MDBList is often days, weeks and months out of date as it is only periodically refreshed. As such, the data that Kometa applies using `mdb_` operations applies may not be the same as you see if you visit those third-party sources directly.
<table class="clearTable">
<tr><td>`tmdb`</td><td>Use TMDb Rating</td></tr>
<tr><td>`imdb`</td><td>Use IMDb Rating</td></tr>
@ -450,15 +466,10 @@ You can create individual blocks of operations by using a list under `operations
TV Shows:
operations:
mass_episode_audience_rating_update:
- mdb
- mdb_average
- tmdb
- 2.0
mass_episode_critic_rating_update:
- imdb
- omdb
- 2.0
mass_episode_user_rating_update:
- trakt_user
- 2.0
```

View file

@ -6,6 +6,10 @@ You can find items using the features of [MDBList.com](https://mdblist.com/) (MD
|:--------------------------------|:--------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|
| [`mdblist_list`](#mdblist-list) | Gets every movie/show in a [MDBList List](https://mdblist.com/toplists/). | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
???+ tip "Note on `mdb` sources"
MDBList is not a live reflection of third-party sites such as CommonSense and Trakt. The data on MDBList is often days, weeks and months out of date as it is only periodically refreshed. As such, the data that Kometa fetches and applies from MDBList may not be the same as you see if you visit those third-party sources directly.
## MDBList List
Finds every item in a [MDBList List](https://mdblist.com/toplists/).

View file

@ -335,6 +335,7 @@ Each Special Text Variables has multiple modifiers that can be used to format th
| `anidb_score_rating` | AniDB Score Rating | `Movies` or `Shows` |
| `mal_rating` | MyAnimeList Rating | `Movies` or `Shows` |
??? tip "Special Rating Text Modifiers"
| Modifier | Description | Example |
@ -344,6 +345,10 @@ Each Special Text Variables has multiple modifiers that can be used to format th
| `#` | Rating on a 10 point scale removing `.0` as needed | `8.7`, `9` |
| `/` | Rating on a 5 point scale | `8.6` shows as `4.3`, `9.0` shows as `4.5` |
???+ tip "Note on `mdb` sources"
MDBList is not a live reflection of third-party sites such as CommonSense and Trakt. The data on MDBList is often days, weeks and months out of date as it is only periodically refreshed. As such, the data that Kometa applies using `mdb_` operations applies may not be the same as you see if you visit those third-party sources directly.
##### Special String Text
| Variable | Description | Item Types |

View file

@ -229,6 +229,10 @@ Let's change the Trakt rating to that trakt public rating of `85%` instead, whic
* `reapply_overlays: true` should NEVER be used in a live/production environment without a very specific reason, make sure to switch this back to `false` when finished.
???+ tip "Note on `mdb` sources"
MDBList is not a live reflection of third-party sites such as CommonSense and Trakt. The data on MDBList is often days, weeks and months out of date as it is only periodically refreshed. As such, the data that Kometa applies using `mdb_` operations applies may not be the same as you see if you visit those third-party sources directly.
When the above is run you should get:
![](images/ratings-09.png)
@ -266,6 +270,11 @@ Now, finally, let's make the poster rating images match the numbers we put in th
* `reapply_overlays: true` should NEVER be used in a live/production environment without a very specific reason, make sure to switch this back to `false` when finished.
???+ tip "Note on `mdb` sources"
MDBList is not a live reflection of third-party sites such as CommonSense and Trakt. The data on MDBList is often days, weeks and months out of date as it is only periodically refreshed. As such, the data that Kometa applies using `mdb_` operations applies may not be the same as you see if you visit those third-party sources directly.
When the above is run you should get:
![](images/ratings-10.png)