diff options
-rw-r--r-- | GeneratedFeeds.md | 60 |
1 files changed, 25 insertions, 35 deletions
diff --git a/GeneratedFeeds.md b/GeneratedFeeds.md index 88e6224..03d362b 100644 --- a/GeneratedFeeds.md +++ b/GeneratedFeeds.md @@ -1,9 +1,7 @@ -Generated feeds and syndication
-===============================
-
+# Generated feeds and syndication
(Almost) anything you see in the headlines buffer can also be accessed
and syndicated further via a generated feed (in Atom format) by clicking the **little
-feed icon** at the right of the currently loaded feed title; in version:1.12 next to the feed list near the top.
+feed icon** at the right of the currently loaded feed title; in version 1.12 next to the feed list near the top.
| older versions | 1.12 and newer |
| ----- | ----- |
@@ -14,62 +12,54 @@ Since version:1.5.0 you can also limit the articles which go into generated feeds, e.g. you can have a generated feed which includes
published articles from category X.
-Known issues
----------------
+## Known issues
Subscribing to your own feed of search results will cause duplicate articles on each and every feed update.
See this forum thread for details: https://discourse.tt-rss.org/t/behaviour-of-search-feeds/122/2
-Data protection
----------------
+## Data protection
Generated feeds are protected using random unique keys. Key can be
regenerated at any time.
![](https://tt-rss.org/images/gen_feed_dialog.png)
-Anatomy of a generated feed URL
--------------------------------
+## Anatomy of a generated feed URL
### Consider an example:
http://example.com/tt-rss/backend.php?op=rss&id=61&is_cat=1&view-mode=adaptive
-- id (integer) - requested feed ID
-- is\_cat (boolean) - whether the feed is a category
-- view-mode (string) - see below
-- key (string) - automatically generated access key (since
- version:1.5.0)
+- ``id`` (integer) - requested feed ID
+- ``is\_cat`` (boolean) - whether the feed is a category
+- ``view-mode`` (string) - see below
+- ``key`` (string) - automatically generated access key
### Optional parameters:
-- login, pass - see above
-- format - since version:1.6.0 specifies output format, possible
- values: atom, json
-- limit - amount of articles to output, default: 30
-- offset - start output while skipping this amount of articles,
- default: 0 (since version:1.6.0)
-- order - override default headlines order (since version:1.8)
-- ts - output articles newer than timestamp in
- [strtotime](http://www.php.net/manual/en/function.strtotime.php)
- accepted format (since version:1.12) i.e. stuff like
- <code>ts=1%20month%20ago</code>
+- ``login``, ``pass`` - see above
+- ``format`` - since version:1.6.0 specifies output format, possible values: ``atom``, ``json``
+- ``limit`` - amount of articles to output, default: 30
+- ``offset`` - start output while skipping this amount of articles, default: 0
+- ``order`` - override default headlines order
+- ``ts`` - output articles newer than timestamp in [strtotime](http://www.php.net/manual/en/function.strtotime.php)
+ accepted format (since version:1.12) i.e. stuff like <code>ts=1%20month%20ago</code>
### Special feed IDs:
-- -1 - Starred articles
-- -2 - Published articles
-- -3 - Fresh articles
-- -4 - All articles
-- 0 - Archived articles
+- ``-1`` - Starred articles
+- ``-2`` - Published articles
+- ``-3`` - Fresh articles
+- ``-4`` - All articles
+- ``0`` - Archived articles
-Feed IDs < -10 are considered Labels.
+Feed ID values less than -10 are considered Labels.
### Special category IDs (is\_cat=1):
-- 0 - Uncategorized
-- -1 - Special category (includes Starred, Published, etc.)
-- -2 - Labels category (includes your labels)
+- ``0`` - Uncategorized
+- ``-1`` - Special category (includes Starred, Published, etc.)
+- ``-2`` - Labels category (includes your labels)
### View mode values:
|