]> git.immae.eu Git - github/shaarli/Shaarli.git/blame_incremental - doc/RSS-feeds.md
CHANGELOG.md: add an UNPUBLISHED draft for v0.8.1
[github/shaarli/Shaarli.git] / doc / RSS-feeds.md
... / ...
CommitLineData
1#RSS feeds
2### Feeds options
3
4Feeds are available in ATOM with `?do=atom` and RSS with `do=RSS`.
5
6Options:
7- You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
8 - E.G. `https://my.shaarli.domain/?do=atom&permalinks`.
9- 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.
10 - `https://my.shaarli.domain/?do=atom&permalinks&nb=42`
11 - `https://my.shaarli.domain/?do=atom&permalinks&nb=all`
12
13### RSS Feeds or Picture Wall for a specific search/tag
14
15It 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**.
16
17For example, if you want to subscribe only to links tagged `photography`:
18- Go to the desired Shaarli instance.
19- Search for the `photography` tag in the _Filter by tag_ box. Links tagged `photography` are displayed.
20- Click on the `RSS Feed` button.
21- You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.
22- The same method **also works for a full-text search** (_Search_ box) **and for the Picture Wall** (want to only see pictures about `nature`?)
23- You can also build the URLs manually:
24 - `https://my.shaarli.domain/?do=rss&searchtags=nature`
25 - `https://my.shaarli.domain/links/?do=picwall&searchterm=poney`
26
27![(images/rss-filter-1.png) !]((images/rss-filter-1.png)-!.html)(images/rss-filter-2.png)