From d8815e00c769fbf3fe2056bd449fe1e202cf9d6e Mon Sep 17 00:00:00 2001 From: Martin Rotter Date: Wed, 3 Feb 2021 10:47:28 +0100 Subject: [PATCH] update docs --- resources/docs/Documentation.md | 1 + resources/docs/Feed-formats.md | 6 ++++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/resources/docs/Documentation.md b/resources/docs/Documentation.md index f438a5ab0..626ca81e4 100644 --- a/resources/docs/Documentation.md +++ b/resources/docs/Documentation.md @@ -94,6 +94,7 @@ RSS Guard is simple (yet powerful) feed reader. It is able to fetch the most kno * universal plugin for online services with [Google Reader API](#google-reader-api), * possibility of using custom 3rd-party feed synchronization services, * feed metadata fetching including icons, + * support for [scraping websites](Feed-formats.md#websites-scraping-and-related-advanced-features) which do not offer RSS/ATOM feeds and other related advanced features, * simple internal Chromium-based web viewer (or alternative version with simpler and much more lightweight internal viewer), * scriptable [message filtering](#message-filtering), * downloader with own tab and support for up to 6 parallel downloads, diff --git a/resources/docs/Feed-formats.md b/resources/docs/Feed-formats.md index 05a39208a..3e5ac5152 100755 --- a/resources/docs/Feed-formats.md +++ b/resources/docs/Feed-formats.md @@ -54,6 +54,8 @@ You can select source type of each feed. If you select `URL`, then RSS Guard sim 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. +`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. + Any errors in your script must be written to **error output**. @@ -66,7 +68,7 @@ Interpreter must be provided in all cases, arguments do not have to be. For exam |---------|-------------| | `bash#-c "curl 'https://github.com/martinrotter.atom'"` | Downloads ATOM feed file with Bash and Curl. | | `Powershell#"Invoke-WebRequest 'https://github.com/martinrotter.atom' | Select-Object -ExpandProperty Content"` | Downloads ATOM feed file with Powershell. | -| `php#tweeper.php -v 0 https://twitter.com/NSACareers` | Downloads RSS feed file with [Tweeper](https://git.ao2.it/tweeper.git/). Tweeper is utility which is able to produce RSS feed from Twitter. | +| `php#tweeper.php -v 0 https://twitter.com/NSACareers` | Scrape Twitter RSS feed file with [Tweeper](https://git.ao2.it/tweeper.git). Tweeper is utility which is able to produce RSS feed from Twitter and other similar social platforms. | @@ -86,4 +88,4 @@ Typical post-processing filter might do things like advanced CSS formatting of f | Command | Explanation | |---------|-------------| -| `bash.exe#-c "xmllint --format -"` | Pretty-print input XML feed data. | \ No newline at end of file +| `bash#-c "xmllint --format -"` | Pretty-print input XML feed data. | \ No newline at end of file