Doc: sync from Wiki, generate HTML

[github/shaarli/Shaarli.git] / doc / RSS-feeds.md

diff --git a/doc/RSS-feeds.md b/doc/RSS-feeds.md
new file mode 100644 (file)
index 0000000..764b3a4
--- /dev/null
+++ b/doc/RSS-feeds.md
@@ -0,0 +1,15 @@
+#RSS feeds
+### RSS Feeds or Picture Wall for a specific search/tag
+It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to **only display results of a specific search, or for a specific tag**.
+
+For example, if you want to subscribe only to links tagged `photography`:
+- Go to the desired Shaarli instance.
+- Search for the `photography` tag in the _Filter by tag_ box. Links tagged `photography` are displayed.
+- Click on the `RSS Feed` button.
+- You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.
+- The same method **also works for a full-text search** (_Search_ box) **and for the Picture Wall** (want to only see pictures about `nature`?)
+- You can also build the URLs manually: 
+    - `https://my.shaarli.domain/?do=rss&searchtags=nature`
+    - `https://my.shaarli.domain/links/?do=picwall&searchterm=poney`
+
+![(images/rss-filter-1.png) !]((images/rss-filter-1.png)-!.html)(images/rss-filter-2.png)