aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/RSS-feeds.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/md/RSS-feeds.md')
-rw-r--r--doc/md/RSS-feeds.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/md/RSS-feeds.md b/doc/md/RSS-feeds.md
new file mode 100644
index 00000000..9d718172
--- /dev/null
+++ b/doc/md/RSS-feeds.md
@@ -0,0 +1,26 @@
1### Feeds options
2
3Feeds are available in ATOM with `?do=atom` and RSS with `do=RSS`.
4
5Options:
6- You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
7 - E.G. `https://my.shaarli.domain/?do=atom&permalinks`.
8- You can use `nb` parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: `50`). The keyword `all` is available if you want everything.
9 - `https://my.shaarli.domain/?do=atom&permalinks&nb=42`
10 - `https://my.shaarli.domain/?do=atom&permalinks&nb=all`
11
12### RSS Feeds or Picture Wall for a specific search/tag
13
14It 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**.
15
16For example, if you want to subscribe only to links tagged `photography`:
17- Go to the desired Shaarli instance.
18- Search for the `photography` tag in the _Filter by tag_ box. Links tagged `photography` are displayed.
19- Click on the `RSS Feed` button.
20- You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.
21- The same method **also works for a full-text search** (_Search_ box) **and for the Picture Wall** (want to only see pictures about `nature`?)
22- You can also build the URLs manually:
23 - `https://my.shaarli.domain/?do=rss&searchtags=nature`
24 - `https://my.shaarli.domain/links/?do=picwall&searchterm=poney`
25
26![](images/rss-filter-1.png) ![](images/rss-filter-2.png)