doc/RSS-feeds.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta charset="utf-8">
   5   <meta name="generator" content="pandoc">
   6   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
   7   <title>Shaarli – RSS feeds</title>
   8   <style type="text/css">code{white-space: pre;}</style>
   9   <link rel="stylesheet" href="github-markdown.css">
  10   <!--[if lt IE 9]>
  11     <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  12   <![endif]-->
  13 </head>
  14 <body>
  15 <div id="local-sidebar">
  16 <ul>
  17 <li><a href="Home.html">Home</a></li>
  18 <li>Setup
  19 <ul>
  20 <li><a href="Download-and-Installation.html">Download and Installation</a></li>
  21 <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
  22 <li><a href="Server-requirements.html">Server requirements</a></li>
  23 <li><a href="Server-configuration.html">Server configuration</a></li>
  24 <li><a href="Server-security.html">Server security</a></li>
  25 <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
  26 <li><a href="Plugins.html">Plugins</a></li>
  27 </ul></li>
  28 <li><a href="Docker.html">Docker</a></li>
  29 <li><a href="Usage.html">Usage</a>
  30 <ul>
  31 <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
  32 <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
  33 <li><a href="Firefox-share.html">Firefox share</a></li>
  34 <li><a href="RSS-feeds.html">RSS feeds</a></li>
  35 </ul></li>
  36 <li>How To
  37 <ul>
  38 <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
  39 <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
  40 <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
  41 <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
  42 <li><a href="Datastore-hacks.html">Datastore hacks</a></li>
  43 </ul></li>
  44 <li><a href="Troubleshooting.html">Troubleshooting</a></li>
  45 <li><a href="Development.html">Development</a>
  46 <ul>
  47 <li><a href="GnuPG-signature.html">GnuPG signature</a></li>
  48 <li><a href="Coding-guidelines.html">Coding guidelines</a></li>
  49 <li><a href="Directory-structure.html">Directory structure</a></li>
  50 <li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
  51 <li><a href="Plugin-System.html">Plugin System</a></li>
  52 <li><a href="Release-Shaarli.html">Release Shaarli</a></li>
  53 <li><a href="Security.html">Security</a></li>
  54 <li><a href="Static-analysis.html">Static analysis</a></li>
  55 <li><a href="Theming.html">Theming</a></li>
  56 <li><a href="Unit-tests.html">Unit tests</a></li>
  57 </ul></li>
  58 <li>About
  59 <ul>
  60 <li><a href="FAQ.html">FAQ</a></li>
  61 <li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
  62 </ul></li>
  63 </ul>
  64 </div>
  65 <h1 id="rss-feeds">RSS feeds</h1>
  66 <h3 id="feeds-options">Feeds options</h3>
  67 <p>Feeds are available in ATOM with <code>?do=atom</code> and RSS with <code>do=RSS</code>.</p>
  68 <p>Options:</p>
  69 <ul>
  70 <li>You can use <code>permalinks</code> in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
  71 <ul>
  72 <li>E.G. <code>https://my.shaarli.domain/?do=atom&amp;permalinks</code>.</li>
  73 </ul></li>
  74 <li>You can use <code>nb</code> parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: <code>50</code>). The keyword <code>all</code> is available if you want everything.
  75 <ul>
  76 <li><code>https://my.shaarli.domain/?do=atom&amp;permalinks&amp;nb=42</code></li>
  77 <li><code>https://my.shaarli.domain/?do=atom&amp;permalinks&amp;nb=all</code></li>
  78 </ul></li>
  79 </ul>
  80 <h3 id="rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</h3>
  81 <p>It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to <strong>only display results of a specific search, or for a specific tag</strong>.</p>
  82 <p>For example, if you want to subscribe only to links tagged <code>photography</code>:</p>
  83 <ul>
  84 <li>Go to the desired Shaarli instance.</li>
  85 <li>Search for the <code>photography</code> tag in the <em>Filter by tag</em> box. Links tagged <code>photography</code> are displayed.</li>
  86 <li>Click on the <code>RSS Feed</code> button.</li>
  87 <li>You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.</li>
  88 <li>The same method <strong>also works for a full-text search</strong> (<em>Search</em> box) <strong>and for the Picture Wall</strong> (want to only see pictures about <code>nature</code>?)</li>
  89 <li>You can also build the URLs manually:
  90 <ul>
  91 <li><code>https://my.shaarli.domain/?do=rss&amp;searchtags=nature</code></li>
  92 <li><code>https://my.shaarli.domain/links/?do=picwall&amp;searchterm=poney</code></li>
  93 </ul></li>
  94 </ul>
  95 <p><embed src="(images/rss-filter-1.png)-!.html" />(images/rss-filter-2.png)</p>
  96 </body>
  97 </html>