From e7d5e0c3778e49ec2295589eaf223457d9ed9a5c Mon Sep 17 00:00:00 2001 From: Martin Rotter Date: Wed, 3 Feb 2021 10:52:08 +0100 Subject: [PATCH] update docs --- localization/rssguard_en.ts | 248 +++++++++++++++++++++++++++++---- resources/docs/Feed-formats.md | 8 +- 2 files changed, 226 insertions(+), 30 deletions(-) diff --git a/localization/rssguard_en.ts b/localization/rssguard_en.ts index b51e1ab0f..5704f5898 100644 --- a/localization/rssguard_en.ts +++ b/localization/rssguard_en.ts @@ -1062,6 +1062,13 @@ or this functionality is not implemented yet. + + FormEditGreaderAccount + + Server setup + + + FormEditInoreaderAccount @@ -2434,6 +2441,128 @@ Login tokens expiration: %2 + + GreaderAccountDetails + + Service + + + + URL + URL + + + Only download newest X messages per feed + + + + = unlimited + + + + Some feeds require authentication, including GMail feeds. BASIC, NTLM-2 and DIGEST-MD5 authentication schemes are supported. + Some feeds require authentication, including GMail feeds. BASIC, NTLM-2 and DIGEST-MD5 authentication schemes are supported. + + + Authentication + Authentication + + + Username + Username + + + Password + Password + + + Show password + Show password + + + &Test setup + &Test setup + + + Password for your account + + + + Username for your account + + + + URL of your server, without any service-specific path + + + + No test done yet. + No test done yet. + + + Here, results of connection test are shown. + Here, results of connection test are shown. + + + Limiting number of downloaded messages per feed makes updating of feeds faster, but if your feed contains bigger number of messages than specified limit, then some older messages might not be downloaded during feed update. + + + + = unlimited + + + + messages + + + + Network error: '%1'. + Network error: '%1'. + + + Network error, have you entered correct Nextcloud endpoint and password? + + + + You are good to go! + + + + Yeah. + + + + Username cannot be empty. + Username cannot be empty. + + + Username is okay. + Username is okay. + + + Password cannot be empty. + Password cannot be empty. + + + Password is okay. + Password is okay. + + + URL cannot be empty. + URL cannot be empty. + + + URL is okay. + URL is okay. + + + + GreaderNetwork + + Unknown service + + + IOFactory @@ -3140,11 +3269,11 @@ Login tokens expiration: %2 - Failed to starting OAuth redirection listener. Maybe your rights are not high enough. + You can close this window now. Go back to %1. - You can close this window now. Go back to %1. + Failed to start OAuth redirection listener. Maybe your rights are not high enough. @@ -3363,6 +3492,10 @@ version by clicking this popup notification. Standard online feeds (RSS/ATOM/JSON) + + Google Reader API is used by many online RSS readers. This is here to support + + RecycleBin @@ -3401,6 +3534,29 @@ version by clicking this popup notification. + + ScriptException + + script line is not well-formed + + + + script threw an error + + + + script's interpreter was not found + + + + script execution took too long + + + + unknown error + unknown error + + SearchTextWidget @@ -3859,6 +4015,10 @@ Authors of this application are NOT responsible for lost data. Bring application window to front once message is opened in external web browser + + Display real icons of feeds in list of messages instead of read/unread icons + + SettingsGeneral @@ -4085,10 +4245,6 @@ Authors of this application are NOT responsible for lost data. Metadata not fetched Metadata not fetched - - Metadata was not fetched because: %1. - Metadata was not fetched because: %1. - Network status: %1 @@ -4096,6 +4252,22 @@ Encoding: %2 Type: %3 + + Script + + + + Local file + + + + Unknown + + + + Metadata was not fetched. + + StandardFeedDetails @@ -4135,10 +4307,6 @@ Type: %3 Description Description - - URL - URL - Fetch metadata Fetch metadata @@ -4171,14 +4339,6 @@ Type: %3 Set description for your feed. - - Full feed url including scheme - - - - Set url for your feed. - - Icon selection Icon selection @@ -4207,18 +4367,10 @@ Type: %3 Icon metadata fetched. - - Result: %1. - - Icon metadata not fetched. - - Error: %1. - Error: %1. - No icon fetched. @@ -4296,6 +4448,50 @@ Type: %3 Icon type: Icon type: + + Source + + + + Post-process script + + + + You can use URL as a source of your feed or you can produce your feed with custom script. Also, you can post-process generated feed data with yet another script if you wish. These are advanced features and make sure to read the documentation before your use them. + + + + Full feed source identifier + + + + Full feed source identifier which can be URL. + + + + Full command to execute + + + + You can enter full command including interpreter here. + + + + Here you can enter script executaion line, including interpreter. + + + + The source is ok. + + + + The source needs to include "#" separator. + + + + The source is empty. + + StandardServiceRoot diff --git a/resources/docs/Feed-formats.md b/resources/docs/Feed-formats.md index 3e5ac5152..095af21f9 100755 --- a/resources/docs/Feed-formats.md +++ b/resources/docs/Feed-formats.md @@ -46,15 +46,15 @@ You just select output file (in case of OPML export), check desired feeds and hi ### Websites scraping and related advanced features -> **Only proceed if you consider yourself as power user and you know you are doing!** +> **Only proceed if you consider yourself to be a power user and you know what you are doing!** RSS Guard 3.9.0+ offers extra advanced features which are inspired by [Liferea](https://lzone.de/liferea/). -You can select source type of each feed. If you select `URL`, then RSS Guard simply downloads feed file from given location. +You can select source type of each feed. If you select `URL`, then RSS Guard simply downloads feed file from given location and behave like everyone would expect. -However, if you choose `Script` option, then you cannot provide URL of your feed and you rely on custom script to obtain your script and provide its contents to **standard output**. Resulting data written to standard output should be valid feed file, for example RSS or ATOM XML file. +However, if you choose `Script` option, then you cannot provide URL of your feed and you rely on custom script to generate feed file and provide its contents to **standard output**. Resulting data written to standard output should be valid feed file, for example RSS or ATOM XML file. -`Fetch ut now` button also works with `Script` option. Therefore, if your source script and (optional) post-process script in cooperation deliver a valid feed file to the output, then all important metadata, like title or icon of the feed, can be automagically discovered. +`Fetch it now` button also works with `Script` option. Therefore, if your source script and (optional) post-process script in cooperation deliver a valid feed file to the output, then all important metadata, like title or icon of the feed, can be automagically discovered.