MyShaarli/doc/md/RSS-feeds.md

### Feeds options

Feeds are available in ATOM with `/feed-atom` and RSS with `/feed-rss`.

Options:

- You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
    - E.G. `https://my.shaarli.domain/feed-atom?permalinks`.
- 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.
    - `https://my.shaarli.domain/feed-atom?permalinks&nb=42`
    - `https://my.shaarli.domain/feed-atom?permalinks&nb=all`

### 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/picture-wall?searchterm=poney`

![](images/rss-filter-1.png) ![](images/rss-filter-2.png)
Update docs from Wiki 2016-04-14 14:20:23 +02:00			`### Feeds options`

RSS/ATOM feeds: process through Slim controller 2020-05-18 17:17:36 +02:00			Feeds are available in ATOM with `/feed-atom` and RSS with `/feed-rss`.
Update docs from Wiki 2016-04-14 14:20:23 +02:00
			`Options:`
documentation: fix rendering and internal references This is mainly cleanup after switching from Github-flavoured Markdown rendered by Github Pages, to standard Markdown rendered by MkDocs. Changed: - rephrase some section titles Fixed: - list rendering (items, sub-items)) - code rendering - quotes - dead links Removed: - extraneous navigational elements Signed-off-by: VirtualTam <virtualtam@flibidi.net> 2017-08-05 11:56:24 +02:00
Update docs from Wiki 2016-04-14 14:20:23 +02:00			- You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
RSS/ATOM feeds: process through Slim controller 2020-05-18 17:17:36 +02:00			- E.G. `https://my.shaarli.domain/feed-atom?permalinks`.
Update docs from Wiki 2016-04-14 14:20:23 +02:00			- 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.
RSS/ATOM feeds: process through Slim controller 2020-05-18 17:17:36 +02:00			- `https://my.shaarli.domain/feed-atom?permalinks&nb=42`
			- `https://my.shaarli.domain/feed-atom?permalinks&nb=all`
Update docs from Wiki 2016-04-14 14:20:23 +02:00
Doc: sync from Wiki, generate HTML Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - <Page Name> Signed-off-by: VirtualTam <virtualtam@flibidi.net> 2015-07-22 05:02:10 +02:00			`### RSS Feeds or Picture Wall for a specific search/tag`
Update docs from Wiki 2016-04-14 14:20:23 +02:00
Doc: sync from Wiki, generate HTML Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - <Page Name> Signed-off-by: VirtualTam <virtualtam@flibidi.net> 2015-07-22 05:02:10 +02:00			`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`:
documentation: fix rendering and internal references This is mainly cleanup after switching from Github-flavoured Markdown rendered by Github Pages, to standard Markdown rendered by MkDocs. Changed: - rephrase some section titles Fixed: - list rendering (items, sub-items)) - code rendering - quotes - dead links Removed: - extraneous navigational elements Signed-off-by: VirtualTam <virtualtam@flibidi.net> 2017-08-05 11:56:24 +02:00
Doc: sync from Wiki, generate HTML Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - <Page Name> Signed-off-by: VirtualTam <virtualtam@flibidi.net> 2015-07-22 05:02:10 +02:00			`- 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`?)
Process picwall rendering through Slim controller + UT 2020-01-26 11:15:15 +01:00			`- You can also build the URLs manually:`
Doc: sync from Wiki, generate HTML Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - <Page Name> Signed-off-by: VirtualTam <virtualtam@flibidi.net> 2015-07-22 05:02:10 +02:00			- `https://my.shaarli.domain/?do=rss&searchtags=nature`
Process picwall rendering through Slim controller + UT 2020-01-26 11:15:15 +01:00			- `https://my.shaarli.domain/links/picture-wall?searchterm=poney`
Doc: sync from Wiki, generate HTML Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - <Page Name> Signed-off-by: VirtualTam <virtualtam@flibidi.net> 2015-07-22 05:02:10 +02:00
Generate HTML documentation using MkDocs (WIP) MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation 2017-01-26 18:52:54 +01:00			`![](images/rss-filter-1.png) ![](images/rss-filter-2.png)`