aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/RSS-feeds
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-07-04 21:37:30 +0200
committerGitHub <noreply@github.com>2017-07-04 21:37:30 +0200
commit5b25a9635fe808bc1c4f3eee8cdf8485115da75d (patch)
treed5c46525f3c739d9c63de860427e0b3cadd688e5 /doc/html/RSS-feeds
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
parent8bf94136e10c64496711c8f66a4f58f89c515360 (diff)
downloadShaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.gz
Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.zst
Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.zip
Merge pull request #772 from nodiscc/rtfd
Generate HTML documentation using MkDocs
Diffstat (limited to 'doc/html/RSS-feeds')
-rw-r--r--doc/html/RSS-feeds/index.html355
1 files changed, 355 insertions, 0 deletions
diff --git a/doc/html/RSS-feeds/index.html b/doc/html/RSS-feeds/index.html
new file mode 100644
index 00000000..a4b7339f
--- /dev/null
+++ b/doc/html/RSS-feeds/index.html
@@ -0,0 +1,355 @@
1<!DOCTYPE html>
2<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
3<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
4<head>
5 <meta charset="utf-8">
6 <meta http-equiv="X-UA-Compatible" content="IE=edge">
7 <meta name="viewport" content="width=device-width, initial-scale=1.0">
8
9
10 <link rel="shortcut icon" href="../img/favicon.ico">
11 <title>RSS feeds - Shaarli Documentation</title>
12 <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
13
14 <link rel="stylesheet" href="../css/theme.css" type="text/css" />
15 <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
16 <link rel="stylesheet" href="../css/highlight.css">
17 <link href="../github-markdown.css" rel="stylesheet">
18
19 <script>
20 // Current page data
21 var mkdocs_page_name = "RSS feeds";
22 var mkdocs_page_input_path = "RSS-feeds.md";
23 var mkdocs_page_url = "/RSS-feeds/";
24 </script>
25
26 <script src="../js/jquery-2.1.1.min.js"></script>
27 <script src="../js/modernizr-2.8.3.min.js"></script>
28 <script type="text/javascript" src="../js/highlight.pack.js"></script>
29
30</head>
31
32<body class="wy-body-for-nav" role="document">
33
34 <div class="wy-grid-for-nav">
35
36
37 <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
38 <div class="wy-side-nav-search">
39 <a href=".." class="icon icon-home"> Shaarli Documentation</a>
40 <div role="search">
41 <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
42 <input type="text" name="q" placeholder="Search docs" />
43 </form>
44</div>
45 </div>
46
47 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
48 <ul class="current">
49
50
51 <li class="toctree-l1">
52
53 <a class="" href="..">Home</a>
54 </li>
55
56 <li class="toctree-l1">
57
58 <span class="caption-text">Setup</span>
59 <ul class="subnav">
60 <li class="">
61
62 <a class="" href="../Download-and-Installation/">Download and Installation</a>
63 </li>
64 <li class="">
65
66 <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
67 </li>
68 <li class="">
69
70 <a class="" href="../Server-requirements/">Server requirements</a>
71 </li>
72 <li class="">
73
74 <a class="" href="../Server-configuration/">Server configuration</a>
75 </li>
76 <li class="">
77
78 <a class="" href="../Server-security/">Server security</a>
79 </li>
80 <li class="">
81
82 <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
83 </li>
84 <li class="">
85
86 <a class="" href="../Plugins/">Plugins</a>
87 </li>
88 </ul>
89 </li>
90
91 <li class="toctree-l1">
92
93 <span class="caption-text">Docker</span>
94 <ul class="subnav">
95 <li class="">
96
97 <a class="" href="../Docker-101/">Docker 101</a>
98 </li>
99 <li class="">
100
101 <a class="" href="../Shaarli-images/">Shaarli images</a>
102 </li>
103 <li class="">
104
105 <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
106 </li>
107 <li class="">
108
109 <a class="" href="../Docker-resources/">Docker resources</a>
110 </li>
111 </ul>
112 </li>
113
114 <li class="toctree-l1">
115
116 <span class="caption-text">Usage</span>
117 <ul class="subnav">
118 <li class="">
119
120 <a class="" href="../Features/">Features</a>
121 </li>
122 <li class="">
123
124 <a class="" href="../Bookmarklet/">Bookmarklet</a>
125 </li>
126 <li class="">
127
128 <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
129 </li>
130 <li class="">
131
132 <a class="" href="../Firefox-share/">Firefox share</a>
133 </li>
134 <li class=" current">
135
136 <a class="current" href="./">RSS feeds</a>
137 <ul class="subnav">
138
139 <li class="toctree-l3"><a href="#feeds-options">Feeds options</a></li>
140
141
142 <li class="toctree-l3"><a href="#rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</a></li>
143
144
145 </ul>
146 </li>
147 <li class="">
148
149 <a class="" href="../REST-API/">REST API</a>
150 </li>
151 </ul>
152 </li>
153
154 <li class="toctree-l1">
155
156 <span class="caption-text">How To</span>
157 <ul class="subnav">
158 <li class="">
159
160 <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
161 </li>
162 <li class="">
163
164 <a class="" href="../Various-hacks/">Various hacks</a>
165 </li>
166 </ul>
167 </li>
168
169 <li class="toctree-l1">
170
171 <a class="" href="../Troubleshooting/">Troubleshooting</a>
172 </li>
173
174 <li class="toctree-l1">
175
176 <span class="caption-text">Development</span>
177 <ul class="subnav">
178 <li class="">
179
180 <a class="" href="../Development-guidelines/">Development guidelines</a>
181 </li>
182 <li class="">
183
184 <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
185 </li>
186 <li class="">
187
188 <a class="" href="../GnuPG-signature/">GnuPG signature</a>
189 </li>
190 <li class="">
191
192 <a class="" href="../Coding-guidelines/">Coding guidelines</a>
193 </li>
194 <li class="">
195
196 <a class="" href="../Directory-structure/">Directory structure</a>
197 </li>
198 <li class="">
199
200 <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
201 </li>
202 <li class="">
203
204 <a class="" href="../Plugin-System/">Plugin System</a>
205 </li>
206 <li class="">
207
208 <a class="" href="../Release-Shaarli/">Release Shaarli</a>
209 </li>
210 <li class="">
211
212 <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
213 </li>
214 <li class="">
215
216 <a class="" href="../Security/">Security</a>
217 </li>
218 <li class="">
219
220 <a class="" href="../Static-analysis/">Static analysis</a>
221 </li>
222 <li class="">
223
224 <a class="" href="../Theming/">Theming</a>
225 </li>
226 <li class="">
227
228 <a class="" href="../Unit-tests/">Unit tests</a>
229 </li>
230 </ul>
231 </li>
232
233 <li class="toctree-l1">
234
235 <span class="caption-text">About</span>
236 <ul class="subnav">
237 <li class="">
238
239 <a class="" href="../FAQ/">FAQ</a>
240 </li>
241 <li class="">
242
243 <a class="" href="../Community-&-Related-software/">Community & Related software</a>
244 </li>
245 </ul>
246 </li>
247
248 </ul>
249 </div>
250 &nbsp;
251 </nav>
252
253 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
254
255
256 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
257 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
258 <a href="..">Shaarli Documentation</a>
259 </nav>
260
261
262 <div class="wy-nav-content">
263 <div class="rst-content">
264 <div role="navigation" aria-label="breadcrumbs navigation">
265 <ul class="wy-breadcrumbs">
266 <li><a href="..">Docs</a> &raquo;</li>
267
268
269
270 <li>Usage &raquo;</li>
271
272
273
274 <li>RSS feeds</li>
275 <li class="wy-breadcrumbs-aside">
276
277 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/RSS-feeds.md"
278 class="icon icon-github"> Edit on GitHub</a>
279
280 </li>
281 </ul>
282 <hr/>
283</div>
284 <div role="main">
285 <div class="section">
286
287 <h3 id="feeds-options">Feeds options</h3>
288<p>Feeds are available in ATOM with <code>?do=atom</code> and RSS with <code>do=RSS</code>.</p>
289<p>Options:
290- You can use <code>permalinks</code> in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
291 - E.G. <code>https://my.shaarli.domain/?do=atom&amp;permalinks</code>.
292- 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.
293 - <code>https://my.shaarli.domain/?do=atom&amp;permalinks&amp;nb=42</code>
294 - <code>https://my.shaarli.domain/?do=atom&amp;permalinks&amp;nb=all</code></p>
295<h3 id="rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</h3>
296<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>
297<p>For example, if you want to subscribe only to links tagged <code>photography</code>:
298- Go to the desired Shaarli instance.
299- Search for the <code>photography</code> tag in the <em>Filter by tag</em> box. Links tagged <code>photography</code> are displayed.
300- Click on the <code>RSS Feed</code> button.
301- You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.
302- 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>?)
303- You can also build the URLs manually:
304 - <code>https://my.shaarli.domain/?do=rss&amp;searchtags=nature</code>
305 - <code>https://my.shaarli.domain/links/?do=picwall&amp;searchterm=poney</code></p>
306<p><img alt="" src="../images/rss-filter-1.png" /> <img alt="" src="../images/rss-filter-2.png" /></p>
307
308 </div>
309 </div>
310 <footer>
311
312 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
313
314 <a href="../REST-API/" class="btn btn-neutral float-right" title="REST API">Next <span class="icon icon-circle-arrow-right"></span></a>
315
316
317 <a href="../Firefox-share/" class="btn btn-neutral" title="Firefox share"><span class="icon icon-circle-arrow-left"></span> Previous</a>
318
319 </div>
320
321
322 <hr/>
323
324 <div role="contentinfo">
325 <!-- Copyright etc -->
326
327 </div>
328
329 Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
330</footer>
331
332 </div>
333 </div>
334
335 </section>
336
337 </div>
338
339 <div class="rst-versions" role="note" style="cursor: pointer">
340 <span class="rst-current-version" data-toggle="rst-current-version">
341
342 <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
343
344
345 <span><a href="../Firefox-share/" style="color: #fcfcfc;">&laquo; Previous</a></span>
346
347
348 <span style="margin-left: 15px"><a href="../REST-API/" style="color: #fcfcfc">Next &raquo;</a></span>
349
350 </span>
351</div>
352 <script src="../js/theme.js"></script>
353
354</body>
355</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-18 06:32:15 +0000