Merge branch 'help-collection' into gh-pages

README.md

@@ -6,6 +6,9 @@ Note the special instructions for [GitHub Pages](https://jekyllrb.com/docs/githu
 
 https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll
 
+[Liquid syntax](https://shopify.github.io/liquid/basics/introduction/)
+
+[Collections](https://jekyllrb.com/docs/collections/)
 
 ```
 # update gems

_config.yml

@@ -11,4 +11,8 @@ url: "https://www.seriesgui.de" # the base hostname & protocol for your site
 
 # Compress the generated CSS file
 sass:
-    style: compressed
+  style: compressed
+
+collections:
+  help:
+    output: true

_help/fix/airtimes.html

@@ -0,0 +1,15 @@
+---
+layout: help
+title: "The release time of a show or episode is wrong"
+help_category: fix
+order: 6
+---
+
+<p><span class="emoji">ℹ</span> The show/episode release times are restricted to the <strong>original release</strong> in the country of origin.</p>
+<p><span class="emoji">✅</span> If you want local listings and listings of re-broadcasts, please look for a suitable TV guide offering in your region.</p>
+<p>If <strong>the release country is known</strong>, SeriesGuide assumes the release time is in a time zone of this country (for example Eastern Time for US shows, British Time for British shows, Central European Time for German shows, ...). Then it is <strong>converted to your device time zone</strong>.</p>
+<p>If <strong>the release country is not known</strong>, SeriesGuide will assume the country to be the United States of America.</p>
+<p>You can view the country in the detailed show information.</p>
+<p><span class="emoji">ℹ</span> If your device is <strong>set to a US mainland time zone</strong>, SeriesGuide will automatically adjust the release time (for example one hour earlier in Central Time).</p>
+<p>If <strong>the displayed country is not correct</strong> it can be changed at <a href="{% link _help/how-to/basics/sources.html %}">the data source</a>.</p>
+<p>If <strong>the country is correct</strong>, but you believe the release time is incorrectly converted in SeriesGuide, please <a href="{% link _help/other/contact.html %}">send a message</a>.</p>

_help/fix/battery.html

@@ -0,0 +1,15 @@
+---
+layout: help
+title: "Notifications appear too late"
+help_category: fix
+order: 9
+---
+
+<p>If notifications only appear once you start using your device, SeriesGuide is affected by the battery use optimization settings of your device.</p>
+<p>To disable battery optimization for SeriesGuide:</p>
+<ul>
+  <li>open the <strong>Settings</strong> app,</li>
+  <li>go to <strong>Apps</strong> and look for SeriesGuide,</li>
+  <li>open the <strong>Battery</strong> section,</li>
+  <li>choose <strong>Unrestricted</strong> or change <strong>Battery optimization</strong> to <strong>Don't optimize</strong>.</li>
+</ul>

_help/fix/images.html

@@ -0,0 +1,22 @@
+---
+layout: help
+title: "Images are not displayed"
+help_category: fix
+order: 8
+---
+
+<dl class="sg-padded-list">
+    <dt>Desired language has no poster</dt>
+    <dd>Try to <a href="{% link _help/how-to/basics/content-language.html %}">change the language of the show</a>, most often to English. If you prefer another language, <a href="{% link _help/how-to/basics/content-language.html %}">change the alternative language</a> in settings to English instead.</dd>
+
+    <dt>Image cache is corrupted</dt>
+    <dd>You can try clearing the cache for SeriesGuide. Tap <strong>More</strong> <span class="material-symbols-outlined" aria-hidden="true">menu</span> > <b>Settings</b> > <b>Clear image cache</b>. In the App Info screen that opens, go to Storage and tap Clear Cache.</dd>
+
+    <img class="img-fluid" src="/images/cache-settings-770x248.png" width="390" alt="Screenshot of Clear Cache button on settings screen." />
+
+    <dt class="mt-3"><em>Images over Wi-Fi only</em> is enabled</dt>
+    <dd>If your current connection is metered and this setting is enabled, no images are downloaded. Tap <strong>More</strong> <span class="material-symbols-outlined" aria-hidden="true">menu</span> > <b>Settings</b> and disable the setting.</dd>
+
+    <dt><em>Prevent spoilers</em> setting is enabled</dt>
+    <dd>If an episode is not watched and this setting is enabled, the episode image remains hidden. Tap <strong>More</strong> <span class="material-symbols-outlined" aria-hidden="true">menu</span> > <b>Settings</b> > <b>Advanced</b>. Disable the setting.</dd>
+  </dl>

_help/fix/missing.html

@@ -0,0 +1,20 @@
+---
+layout: help
+title: "Can not find a show or movie"
+help_category: fix
+order: 4
+---
+
+<p><strong>If the show is added to your library:</strong></p>
+<ul>
+    <li>From the <strong>Shows</strong> list, tap <strong>Filter shows</strong> <span class="material-symbols-outlined" aria-hidden="true">filter_list</span>.</li>
+    <li>Check the Filter shows and Sort shows settings. A show might be not shown or shown at an unexpected position because of them.</li>
+</ul>
+
+<p><strong>When trying to search for a show or movie:</strong></p>
+<ul>
+    <li>If search can't find a show, <a href="https://discuss.seriesgui.de/t/tips-for-searching-for-shows/67">try the tips post on the forum</a>.</li>
+    <li>Also, sometimes a supposedly TV show is actually a series of movies and can be found under Movies.</li>
+    <li>The same applies to movies, for example made for TV movies are found under Shows.</li>
+</ul>
+<p>Anyhow, all series and movie data is loaded from the user-created database at <a href="{{ site.data.links.tmdb }}">themoviedb.org</a></a>. Feel free to help out there to add missing information for all other users.</p>

_help/fix/outage.html

@@ -0,0 +1,42 @@
+---
+layout: help
+title: Could not talk to TMDB or Trakt
+help_category: fix
+order: 2
+---
+
+<p><span class="emoji">ℹ️</span> <strong>Since 2022-04-10, in Russia or Belarus</strong> it is currently not 
+    possible to search for, add or update shows and movies in SeriesGuide.</p>
+
+<p>This is because the data source SeriesGuide uses, <a href="{{ site.data.links.tmdb }}">TMDB</a>, 
+is blocking access from IP addresses attributed to the Russia or Belarus region out of solidarity due to the ongoing war in Ukraine. 
+    <a href="https://blog.themoviedb.org/the-movie-database-suspends-access-from-russia-and-belarus-b6a1a96fb35b">Read the TMDB statement.</a></p>
+
+<hr>
+
+<p><strong><span class="emoji">ℹ️</span> Some countries or internet service providers (ISP) are known to block 
+<a href="{{ site.data.links.tmdb }}">themoviedb.org</a> or <a href="{{ site.data.links.trakt }}">trakt.tv</a></strong>  
+(like <a href="https://www.themoviedb.org/talk/65d4b89ce640d6017dececac">in India</a>).
+In this case it may be possible to use custom DNS servers, switch to another connection (different ISP) or use VPN software (at your own risk).</p>
+
+<hr>
+
+<p>If you receive this error there might be a temporary issue with either your internet connection 
+or one of the services SeriesGuide uses.</p>
+
+<p><strong>You can check the following to learn about ongoing issues and their status:</strong></p>
+<ul>
+<li><a href="https://www.themoviedb.org/talk">TMDB support forums</a> and <a href="https://status.themoviedb.org">TMDB Status page</a></li>
+<li><a href="https://twitter.com/trakt">Trakt X account</a> and <a href="https://status.trakt.tv/">Trakt status page</a></li>
+<li><a href="{{ site.data.links.x }}">SeriesGuide X account</a> or <a href="{{ site.data.links.community }}">announcements on the forum</a></li>
+</ul>
+
+<p>Keep in mind that TMDB, Trakt as well as SeriesGuide are services operated by a small or even one-person staff. 
+If the service experiences issues, the person which can fix it can not always be available 
+(it's night time, they are working another job or are on holiday). So it can take time until 
+issues are resolved. Please do not expect 24/7 availability like from services that can 
+afford a large, around the world support staff.</p>
+
+<p><strong>So please be patient and try again later.</strong> If the issue persists after a few days, then please let me know about it.</p>
+
+<p>Thank you for understanding!</p>

_help/fix/subs.html

@@ -0,0 +1,12 @@
+---
+layout: help
+title: Subscription is not recognized
+help_category: fix
+order: 1
+---
+
+<p>If you have an active subscription, but SeriesGuide does not recognize it, have a look at the <a href="https://support.google.com/googleplay/answer/1050566">troubleshooting steps from Google Play Help</a>.</p>
+
+<p>If you have multiple Google accounts, check that SeriesGuide was installed with the correct account active in the Play Store app.</p>
+
+<p>Should this not resolve your issue, please <a href="{% link _help/other/contact.html %}">contact me</a>.</p>

_help/fix/syncfail.html

@@ -0,0 +1,32 @@
+---
+layout: help
+title: Show, episode or movie data is outdated or missing
+help_category: fix
+order: 3
+---
+
+<p><span class="emoji">ℹ</span> <strong>On OnePlus OxygenOS 12</strong> syncing fails if your device has less than 10% free storage.</p>
+<p><span class="emoji">ℹ</span> Show and movie data is loaded from the user-created database
+  at <a href="{{ site.data.links.tmdb }}">themoviedb.org</a>. The contributors there are typically quick
+  to update things. If not, consider to help out.</p>
+<p><span class="emoji">ℹ</span> Access to <a href="{% link _help/how-to/basics/sources.html %}">the services SeriesGuide uses</a> 
+  might be (temporarily) blocked in your region, for example because your internet connection has issues or
+  your internet provider is blocking access. Try <a href="{{ site.data.links.community }}">checking the forum</a>
+  for other affected users.</p>
+
+<p>Regardless, here are some things to check and try:</p>
+
+<p class="title">Check <em>Sync &amp; Update</em> setting</p>
+<p>Tap <strong>More</strong> <span class="material-symbols-outlined">menu</span>, then <b>Settings</b>
+  and check if <strong>Sync &amp; Update</strong> is enabled.</p>
+
+<p class="title">Check device Accounts sync setting</p>
+<p>Open the Settings app of your device. Find and open the Accounts settings and check that 
+  <strong>Auto-sync data</strong> is enabled. You should also see a SeriesGuide Sync account there.</p>
+
+<p class="title">Check device power saving settings</p>
+<p>SeriesGuide might not be able to update in the background because of battery use optimization settings. 
+  Try to <a href="{% link _help/fix/battery.html %}">exclude SeriesGuide from battery use optimizations</a>.</p>
+
+<p class="title">Last resort: remove and add the show again</p>
+<p>If a show does not update, as a last resort, remove the show and add it again.</p>

_help/fix/timezone.html

@@ -0,0 +1,14 @@
+---
+layout: help
+title: "After changing the time zone, times are incorrect"
+help_category: fix
+order: 11
+---
+
+<p>Please stop SeriesGuide and restart it:</p>
+<ol>
+  <li>Tap the switch app button on your device.</li>
+  <li>Swipe SeriesGuide away or tap the X button.</li>
+  <li>Launch the SeriesGuide app again.</li>
+</ol>
+<p>If that won't help, try to <a href="{% link _help/how-to/basics/update.html %}">update all shows</a>.</p>

_help/fix/translation.html

@@ -0,0 +1,11 @@
+---
+layout: help
+title: "A translation is wrong or missing"
+help_category: fix
+order: 5
+---
+
+<p class="title">Show, episode or movie titles and descriptions</p>
+<p>You can help improve the translation at <a href="{{ site.data.links.tmdb }}">themoviedb.org</a>.</p>
+<p class="title">User interface (like buttons)</p>
+<p>Please <a href="#contact">send a message</a> or consider <a href="{{ site.data.links.crowdin }}">to translate or proof read</a>.</p>

_help/fix/watch.html

@@ -0,0 +1,10 @@
+---
+layout: help
+title: "Watching shows or movies is not supported"
+help_category: fix
+order: 7
+---
+
+<p>You can <strong>not</strong> watch shows or movies within SeriesGuide.</p>
+<p>However, on the episode and movie details screens there is a Stream or puchase button to help you find streaming and purchasing services a show or movie is available on in your region.</p>
+

_help/fix/widget.html

@@ -0,0 +1,9 @@
+---
+layout: help
+title: "The widget is not updating or is missing"
+help_category: fix
+order: 10
+---
+
+<p>You may have moved SeriesGuide to the SD card/external storage. For SeriesGuide to work properly it <strong>has to be installed on your device/internal memory</strong>. Move it back and everything should be fine again (if not, <strong>try rebooting your device</strong>).</p>
+<p>If that is not the case, it may help to <a href="{% link _help/fix/battery.html %}">exclude SeriesGuide from battery optimizations</a>.</p>

_help/how-to/backup/autobackup.html

@@ -0,0 +1,24 @@
+---
+layout: help
+title: "Restore your data from an Auto Backup"
+help_category: how-to-backup
+order: 2
+---
+
+<p>Auto Backup creates a file-based <strong>weekly automatic backup</strong> of your shows, lists and movies.</p>
+<p><strong>To restore an Auto Backup:</strong></p>
+<ol>
+  <li>In the bottom bar, tap <strong>More</strong> <span class="material-symbols-outlined" aria-hidden="true">menu</span> > <strong>Settings</strong>.</li>
+  <li>Tap <strong>Auto Backup</strong>.</li>
+  <li>Tap the <strong>Restore Auto Backup</strong> button. If it is disabled, there is no auto backup available to restore from. Use the Backup/Restore tool to restore a backup from another location (e.g. Google Drive).</li>
+</ol>
+<p><span class="emoji">🚨</span> <strong>Not recommended when using SeriesGuide Cloud or Trakt.</strong> Syncing with Cloud or Trakt may overwrite any restored backup. With SeriesGuide Cloud, you can delete your account before restoring the backup, then re-create it afterwards to upload only the restored data.</p>
+<p><strong>To configure Auto Backup:</strong></p>
+<ol>
+  <li>In the bottom bar, tap <strong>More</strong> <span class="material-symbols-outlined" aria-hidden="true">menu</span> > <strong>Settings</strong>.</li>
+  <li>Tap <strong>Auto Backup</strong>.</li>
+  <li>Turn Auto Backup on or off.</li>
+  <li>(Recommended) If turned on, enable the option to create copies, select files in an off-device location (e.g. Google Drive).</li>
+</ol>
+<p><span class="emoji">🚨</span> The Auto Backup files are saved to a storage directory that is <strong>removed when the app is uninstalled</strong>. Hence, it is recommended to turn on the option to create additional backups to an off-device location (e.g. Google Drive).</p>
+<p><span class="emoji">ℹ</span> Technical details: the Auto Backup files are stored in <span class="text-monospace text-break">/Android/data/com.battlelancer.seriesguide/files/Backups</span>. On Android 13 or higher, these can only be accessed using the system files app (<a href="https://play.google.com/store/apps/details?id=com.marc.files">shortcut available</a>) or when connecting your device to a PC.</p>

_help/how-to/backup/backup.html

@@ -0,0 +1,29 @@
+---
+layout: help
+title: "Backup or restore your data using files"
+help_category: how-to-backup
+order: 1
+---
+
+<p><strong>To backup your shows, lists and movies:</strong></p>
+<ol>
+  <li>In the bottom bar, tap <strong>More</strong> <span class="material-symbols-outlined" aria-hidden="true">menu</span> > <strong>Settings</strong>.</li>
+  <li>Tap <strong>Backup/Restore</strong>.</li>
+  <li>Look for the <strong>Create backup</strong> section.</li>
+  <li>Tap <strong>Select file</strong> for either shows, lists or movies to create a backup.</li>
+</ol>
+<p><span class="badge badge-info">Note</span> On Android 4.3 and older you can not choose the backup file location. Instead SeriesGuide will store the backup files in the <em>Download</em> folder on your device.</p>
+<p><strong>To restore your shows, lists and movies:</strong></p>
+<ol>
+  <li>In the bottom bar, tap <strong>More</strong> <span class="material-symbols-outlined" aria-hidden="true">menu</span> > <strong>Settings</strong>.</li>
+  <li>Tap <strong>Backup/Restore</strong>.</li>
+  <li>Look for the <strong>Restore backup</strong> section.</li>
+  <li>Tap <strong>Select file</strong> for each type of data you want to restore and select the matching backup file.</li>
+  <li>Tick the check box next to each type you want to restore.</li>
+  <li>Tap <strong>Restore backup</strong>.</li>
+</ol>
+<p><span class="emoji">🚨</span> <strong>Not recommended when using SeriesGuide Cloud or Trakt.</strong> Syncing with Cloud or Trakt may overwrite any restored backup. With SeriesGuide Cloud, you can delete your account before restoring the backup, then re-create it afterwards to upload only the restored data.</p>
+<p>To restore your backup <strong>on another device</strong>, first transfer the created files to it. For example send yourself an email with the files attached, plug your device into a computer to access its storage or save the files to online storage.</p>
+<p><span class="badge badge-info">Note</span> You can use a <a href="https://play.google.com/store/search?q=file+manager&amp;c=apps">file manager</a> app to view or copy the backup files.</p>
+<p><span class="badge badge-info">Note</span> You can import data from another source as long as it uses the <a href="https://github.com/UweTrottmann/SeriesGuide/wiki/JSON-export-format">JSON format that SeriesGuide expects</a>. 
+  Add some shows/lists/movies and create a backup, then just open the created JSON file to see an example with actual data.</p>

_help/how-to/backup/change-email.html

@@ -0,0 +1,14 @@
+---
+layout: help
+title: "Change the email address used for SeriesGuide Cloud"
+help_category: how-to-backup
+order: 4
+---
+
+<p>This requires to create a new account with the new email address. Optionally, you can remove your previous account. To do so:</p>
+<ol>
+  <li>In the bottom bar, tap <strong>More</strong> <span class="material-symbols-outlined" aria-hidden="true">menu</span>.</li>
+  <li>Tap <strong>SeriesGuide Cloud</strong>.</li>
+  <li>Then either <strong>Sign Out</strong> or <strong>Delete account</strong>.</li>
+  <li>Once completed, <strong>Sign In</strong> with a different email address to create a new account. All data on your device will be uploaded to the new account.</li>
+</ol>

_help/how-to/backup/delete-account.html

@@ -0,0 +1,15 @@
+---
+layout: help
+title: "Delete your SeriesGuide Cloud account"
+help_category: how-to-backup
+order: 5
+---
+
+<p><span class="badge badge-info">Note</span> This will remove all uploaded shows, episodes, lists and movies from Cloud. You can create a new account at any time.</p>
+<ol>
+  <li>In the bottom bar, tap <strong>More</strong> <span class="material-symbols-outlined" aria-hidden="true">menu</span>.</li>
+  <li>Tap <strong>SeriesGuide Cloud</strong>.</li>
+  <li>Then tap <strong>Delete account</strong> and confirm.</li>
+</ol>
+<p>If you do not have SeriesGuide installed, you can also <a href="{% link _help/other/contact.html %}">send a message</a> to request your account to get deleted.</p>
+<p><span class="badge badge-info">Note</span> To <a href="https://support.trakt.tv/support/solutions/articles/70000264979-how-do-i-delete-my-account-what-information-is-kept-can-i-make-my-profile-private-">delete your Trakt account</a>, visit <a href="https://trakt.tv/settings">their website</a>.</p>