aboutsummaryrefslogtreecommitdiff
path: root/docs/en/users/04_Subscriptions.md
diff options
context:
space:
mode:
authorGravatar ldv8434 <65482502+ldv8434@users.noreply.github.com> 2021-01-10 14:50:54 -0500
committerGravatar GitHub <noreply@github.com> 2021-01-10 20:50:54 +0100
commitbf344cd30230edbb06fbdaa482a86d3592dc4aa0 (patch)
tree20f547f4fcc93cb72b20b232e821b051216c6c07 /docs/en/users/04_Subscriptions.md
parentee7938ed5f26ac48c46269eb16f8e5067605ab27 (diff)
Update and add to documentation (#3348)
* remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * re-fix link * remove mention of defunct mailing list * grammar fix * replace stream with feed * add optional items, replace stream with feed * replace stream with feed * fix word choice Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * fix word choice better reflect age of project Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * grammar fixes Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * remove double headings Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * change single quote to double quote for consistency * add subreddit link * change php module list to Dockerfile link * fix link to developer index, change html links to md for consistency * update css selector terms Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
Diffstat (limited to 'docs/en/users/04_Subscriptions.md')
-rw-r--r--docs/en/users/04_Subscriptions.md100
1 files changed, 85 insertions, 15 deletions
diff --git a/docs/en/users/04_Subscriptions.md b/docs/en/users/04_Subscriptions.md
index b18272518..bfb3eabe4 100644
--- a/docs/en/users/04_Subscriptions.md
+++ b/docs/en/users/04_Subscriptions.md
@@ -1,11 +1,92 @@
# Adding a feed
1. To add a feed, copy the URL of its RSS or Atom file (for instance, the Framablog RSS URL is `https://framablog.org/feed/`). FreshRSS is able to automatically find the address of the feed for websites that are declaring it in a standard way.
- 2. On FreshRSS, click “Subscriptions management”.
- 3. Paste the URL in “Add an RSS feed” below the page title.
+ 2. In FreshRSS, click the "**+**" button next to “Subscriptions management”.
+ 3. Paste the URL in the “Feed URL” field.
4. (optional): You can select the category for your feed. By default, it will be in “Uncategorized”.
+ 5. (optional): If the subscription requires credentials, you can enter them in the "HTTP username" and "HTTP password" fields.
+ 6. (optional): You can set a timeout for the feed request if the feed requires it.
+ 7. (optional): You can choose to ignore SSL certificate errors (such as with self-signed certificates) by setting "Verify SSL security" to "No". This is not recommended, and it is better to either add the root certificate to the FreshRSS server or to fix the SSL certificate problems on the feed hosting server.
-# Import and export
+# Subscription management
+
+The "Subscription management" submenu allows categories and feeds to be configured. Feeds can be moved between categories by drag-and-drop, or in the individual feed's settings. Hovering over a feed/category will cause a gear icon to appear. Clicking the icon will bring up the settings for that item.
+
+## Category Settings
+
+### Information
+
+* **Title:** Name of category
+ * **Display position:** Defines the order of categories. Lower numbers get priority, non-numbered items come last, and equally numbered items will sort by alphabetical order.
+
+### Archiving
+
+If "Purge Policy" has "By default" selected, then the [default purge policy](./05_Configuration.md) is used and the other options are not displayed. Category options will override the default policy, but they will not override feed-specific options.
+
+## Feed Settings
+
+
+These fields will be auto-filled when adding a feed, but they can be modified later. **Visibility** will define if the feed is displayed in the main feed, only in specific categories, or not at all.
+
+### Archival
+
+This section will let you override the default settings for feed archiving and update frequency.
+
+### Login
+
+Some feeds require a username/password submitted over HTTP. These usually aren't needed for feeds.
+
+### Advanced
+
+#### Retrieve a truncated feed from within FreshRSS
+
+This question comes up regularly, so we'll try to clarify how one can retrieve a truncated RSS feed with FreshRSS. Please note that the process is absolutely not user friendly, but it works. :)
+
+Please be aware that this way you'll generate much more traffic to the originating sites, and they might block you accordingly. FreshRSS performance is also negatively affected, because you'll have to fetch the full article content one by one. So it's a feature to use sparingly!
+
+The "Article CSS selector on original website" corresponds to the "path" consisting of IDs and classes (which in HTML, matches the id and class attributes) to retrieve only the interesting part that corresponds to the article. Ideally, this path starts with an id (which is unique to the page). The basics are explained [here](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors).
+
+##### Example: Rue89
+
+To find this path, you have to go to the address of one of the truncated articles (for example, http://www.rue89.com/2013/10/15/prof-maths-jai-atteint-lextase-dihn-pedagogie-inversee-246635). You look have to look for the "block" of HTML that corresponds to article content (in the source code!).
+
+Here we find that the block that encompasses nothing but the content of the article is ```<div class="content clearfix">```. We'll only use the `.content` class here. Nevertheless, as said above, it's best to start the path with an id. If we go back to the parent block, we find ```<div id="article">``` and that's perfect! The path will be ```#article .content```.
+
+##### Add the corresponding classes to the article CSS path on the feed configuration page. Examples:
+
+* Rue89: ```#article .content```
+* PCINpact: ```#actu_content```
+* Lesnumériques: ```article#body div.text.clearfix```
+* Phoronix: ```#main .content```
+
+##### Combining CSS Classes
+Let's say we have an article which contains ads, and we do not want to have those ads retrieved by FreshRSS. Example HTML:
+```
+<div id="article">
+<h2>wanted</h2>
+<p class="content">wanted content</p>
+<p class="ad">unwanted content</p>
+<h2>wanted</h2>
+<p class="content">wanted content</p>
+<h2>wanted</h2>
+<p class="ad">unwanted content</p>
+<p class="content">wanted content</p>
+</div>
+```
+In this case it's possible to combine multiple CSS selectors with a comma: ```#article p.content, #article h2```
+
+#### Retrieve a truncated feed with external tools
+
+Complementary tools can be used to retrieve full article content, such as:
+
+* [RSS-Bridge](https://github.com/RSS-Bridge/rss-bridge)
+* [Full-Text RSS](https://bitbucket.org/fivefilters/full-text-rss)
+
+### Filter
+
+Articles can be automatically marked as read based on some search terms. See [filtering](./03_Main_view.md#filtering-articles) for more information on how to create these filters.
+
+# Import / export
See [SQLite export/import]( https://github.com/FreshRSS/FreshRSS/tree/master/cli) as an alternative.
## Export
@@ -19,7 +100,7 @@ See [SQLite export/import]( https://github.com/FreshRSS/FreshRSS/tree/master/cli
4. and finally, you can select feeds you want to export (by default, all feeds are selected)
4. Click on “export”.
- ## Import
+## Import
1. Go to the page “Import / export”.
2. Click on “Browse” and select your OPML or archive file on your computer.
@@ -39,14 +120,3 @@ Bookmarklets are little scripts that you can execute to perform various tasks. F
1. Open “Subscriptions management”.
2. Click on “Subscription tools”.
3. Drag the “Subscribe” button to your bookmark toolbar or right click and choose your browser’s “Bookmark link” action.
-
-# Feed management
-
-You can manage your feeds within different categories. A feed cannot be in multiple categories.
-
- 1. Open “Subscriptions management”.
- 2. You can add a category:
- 1. Type the name of your category in “New category”
- 2. Click on “Submit”
- 3. You can move a feed on the category you want with drag & drop
- 4. (optional): If you want the articles of a feed to be visible solely within its category and not in the main view, in the “Visibility” option, select “Show in its category”.