aboutsummaryrefslogtreecommitdiff
path: root/docs/en/users/05_Configuration.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/05_Configuration.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/05_Configuration.md')
-rw-r--r--docs/en/users/05_Configuration.md89
1 files changed, 28 insertions, 61 deletions
diff --git a/docs/en/users/05_Configuration.md b/docs/en/users/05_Configuration.md
index ba8c5006b..660a26bda 100644
--- a/docs/en/users/05_Configuration.md
+++ b/docs/en/users/05_Configuration.md
@@ -66,11 +66,27 @@ If you don't use those buttons because you never browse on mobile or because you
# Reading
-**TODO**
+## Number of articles per page
+
+This setting defines the number of articles to display at once before needing to load more. In normal and reading view, more articles are loaded automatically. In global view, a button will appear at the bottom of the list.
+
+## Articles to display
+
+The status of articles to display when loading FreshRSS. "Adjust showing" will display only unread articles by default, but will display all articles when there are no unread articles to show.
+
+## Use "lazy load" mode to load images
+
+This will set images to load as they are viewed. This can save data, but will can cause images to load in later.
# Archival
-**TODO**
+## Archiving
+
+These are the global options for fetching and retaining articles from feeds. They can be overwridden by individual feed's settings.
+
+## Maintenance
+
+This allows for purging/optimizing the current user's articles in the database.
# Sharing
@@ -93,6 +109,8 @@ To remove an item from the list, follow those simple steps:
1. Press the ```❌``` button next to the share method you want to remove.
1. Submit your changes.
+
+
# Shortcuts
To ease the use of the application, FreshRSS comes with a lot of predefined keyboard shortcuts.
@@ -122,6 +140,14 @@ You can only change user query titles or drop them.
At the moment, there is no helper to build a user query from here.
+# Profile
+
+You can change your email address or password here. The authentication token is required for accessing the aggregated RSS feed for a user. A blank token will disable accessing the RSS feed without being logged in.
+
+# Extensions
+
+Extensions can be managed from this menu. Note that while extensions can be removed from the web interface, they cannot be added from it.
+
# Users
**TODO**
@@ -145,62 +171,3 @@ Require user marie
More information can be found in the [Apache documentation](http://httpd.apache.org/docs/trunk/howto/auth.html#gettingitworking).
-# Subscription management
-
-## Information
-
-**TODO**
-
-## Archival
-
-**TODO**
-
-## Login
-
-**TODO**
-
-## Advanced
-
-### Retrieve a truncated stream 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!
-
-What's meant by "CSS path of articles on the original site" actually 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).
-
-#### 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 within its content, and we do not want to have those ads retrieved by FreshRSS. Example Source Code:
-```
-<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 stream with external tools
-
-Complimentary 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)