diff options
| author | 2021-10-23 13:43:24 +0200 | |
|---|---|---|
| committer | 2021-10-23 13:43:24 +0200 | |
| commit | acbba9adb2e362079ce1fb84be1868b198cc1da0 (patch) | |
| tree | eeeaa9e522f82a9f8f9baaef3b6bd23950eab71a /docs/en/users | |
| parent | dd02c79092aa25cacff1c831815e9ca02b06b620 (diff) | |
Improved markdownlint (#3918)
* Improved markdownlint
* Relaxed rules slighlty
* `npm run markdownlint` for automatic tests
* `npm run markdownlint_fix` for automatic syntax fixing
* Applied the fixes on all our Markdown files
Diffstat (limited to 'docs/en/users')
| -rw-r--r-- | docs/en/users/03_Main_view.md | 40 | ||||
| -rw-r--r-- | docs/en/users/04_Subscriptions.md | 63 | ||||
| -rw-r--r-- | docs/en/users/05_Configuration.md | 69 | ||||
| -rw-r--r-- | docs/en/users/06_Mobile_access.md | 6 | ||||
| -rw-r--r-- | docs/en/users/07_Frequently_Asked_Questions.md | 3 |
5 files changed, 93 insertions, 88 deletions
diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md index 7cbefd7cd..6bead5118 100644 --- a/docs/en/users/03_Main_view.md +++ b/docs/en/users/03_Main_view.md @@ -2,7 +2,7 @@ FreshRSS has three primary viewing modes: Normal, Global, and Reader view. # Normal view -Normal view will allow you to view articles in a compressed view. They can be separated by category or individual feed, or viewed in the "main stream" containing all feeds. Clicking a feed in the sidebar (mobile users will need to click the folder icon to open it) will open that feed's view. +Normal view will allow you to view articles in a compressed view. They can be separated by category or individual feed, or viewed in the "main stream" containing all feeds. Clicking a feed in the sidebar (mobile users will need to click the folder icon to open it) will open that feed's view. ## Article List @@ -10,13 +10,13 @@ By default, the normal view includes six items per article. From left to right: * **Read status:** An envalope icon to show if the article has been read or not. Closed envalopes are unread, open envalopes are read. Clicking on the icon will toggle the read status. * **Favourite status:** A star icon to show if the article has been favourited or not. Filled stars are favourited, empty stars are not. Clicking on the icon will toggle the favourite status. * **Feed name:** The name of the feed that the article is from. Clicking the feed name will move to that feed's view in normal view. -* **Article title:** The title of the article. Clicking will open the article for viewing within FreshRSS. +* **Article title:** The title of the article. Clicking will open the article for viewing within FreshRSS. * **Article date/time:** The time the article was posted. * **Link to original article:** A globe icon that can be clicked to go to the article on the original website. ## Normal View Sidebar -Clicking the gear icon next to an individual feed will display additional options for that feed. +Clicking the gear icon next to an individual feed will display additional options for that feed. * **Filter:** Run the defined filter to mark articles as read * **Statistics:** View statistics about the feed * **See website:** Open the feed's website in another tab @@ -26,7 +26,7 @@ Clicking the gear icon next to an individual feed will display additional option # Global view -Global view allows quick views of feed's statuses at once. Feeds and categories are shown with the number of unread articles next to them. Clicking a feed's name will open it in a view similar to normal view. +Global view allows quick views of feed's statuses at once. Feeds and categories are shown with the number of unread articles next to them. Clicking a feed's name will open it in a view similar to normal view. # Reader view @@ -54,27 +54,28 @@ Here is an example to trigger article update every hour. Special parameters to configure the script - all parameters can be combined: -- Parameter "force" -https://freshrss.example.net/i/?c=feed&a=actualize&force=1 +* Parameter "force" +<https://freshrss.example.net/i/?c=feed&a=actualize&force=1> If *force* is set to 1 all feeds will be refreshed at once. -- Parameter "ajax" -https://freshrss.example.net/i/?c=feed&a=actualize&ajax=1 +* Parameter "ajax" +<https://freshrss.example.net/i/?c=feed&a=actualize&ajax=1> Only a status site is returned and not a complete website. Example: "OK" -- Parameter "maxFeeds" -https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=30 +* Parameter "maxFeeds" +<https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=30> If *maxFeeds* is set the configured amount of feeds is refreshed at once. The default setting is "10". -- Parameter "token" -https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734 +* Parameter "token" +<https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734> Security parameter to prevent unauthorized refreshes. For detailed Documentation see "Form authentication". ### Online cron If you do not have access to the installation server scheduled task, you can still automate the update process. -To do so, you need to create a scheduled task, which need to call a specific URL: https://freshrss.example.net/i/?c=feed&a=actualize (it could be different depending on your installation). Depending on your application authentication method, you need to adapt the scheduled task. +To do so, you need to create a scheduled task, which need to call a specific URL: +<https://freshrss.example.net/i/?c=feed&a=actualize> (it could be different depending on your installation). Depending on your application authentication method, you need to adapt the scheduled task. #### No authentication @@ -139,6 +140,7 @@ This update occurs on the selected feed only. To trigger it, simply click on the # Filtering articles ## Purpose + When the number of articles stored by FreshRSS inevitably grows larger, it's important to use efficient filters to display only a subset of the articles. There are several methods that filter with different criteria. Usually those methods can be combined. ## How-to filter @@ -147,17 +149,17 @@ When the number of articles stored by FreshRSS inevitably grows larger, it's imp This is the easiest method. You only need to click on the category title in the side panel. There are two special categories at the top of the panel: - * *Main feed* displays only articles from feeds marked as available in that category - * *Favourites* displays only articles marked as favourites +* *Main feed* displays only articles from feeds marked as available in that category +* *Favourites* displays only articles marked as favourites ### By feed There are several methods to filter articles by feed: - * by clicking the feed title in the side panel - * by clicking the feed title in the article details - * by filtering in the feed options from the side panel - * by filtering in the feed configuration +* by clicking the feed title in the side panel +* by clicking the feed title in the article details +* by filtering in the feed options from the side panel +* by filtering in the feed configuration  diff --git a/docs/en/users/04_Subscriptions.md b/docs/en/users/04_Subscriptions.md index 881899ce0..93834e354 100644 --- a/docs/en/users/04_Subscriptions.md +++ b/docs/en/users/04_Subscriptions.md @@ -1,23 +1,23 @@ # 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. 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. +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. 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. ## 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. +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. +* **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 @@ -47,16 +47,19 @@ The "Article CSS selector on original website" corresponds to the "path" consis ##### 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!). +To find this path, you have to go to the address of one of the truncated articles. +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: +##### Add the corresponding classes to the article CSS path on the feed configuration page -* Rue89: ```#article .content``` -* PCINpact: ```#actu_content``` -* Lesnumériques: ```article#body div.text.clearfix``` -* Phoronix: ```#main .content``` +Examples: + +* Rue89: ```#article .content``` +* PCINpact: ```#actu_content``` +* Lesnumériques: ```article#body div.text.clearfix``` +* Phoronix: ```#main .content``` ##### Combining CSS Classes @@ -94,20 +97,20 @@ See [SQLite export/import]( https://github.com/FreshRSS/FreshRSS/tree/edge/cli) ## Export - 1. To export your list of feeds, go to “Subscriptions management”. - 2. Click on “Import / export” - 3. You can select for your export: - 1. the list of feeds - 2. labelled articles - 3. favourite articles - 4. and finally, you can select feeds you want to export (by default, all feeds are selected) - 4. Click on “export”. +1. To export your list of feeds, go to “Subscriptions management”. +2. Click on “Import / export” +3. You can select for your export: + 1. the list of feeds + 2. labelled articles + 3. favourite articles + 4. and finally, you can select feeds you want to export (by default, all feeds are selected) +4. Click on “export”. ## Import - 1. Go to the page “Import / export”. - 2. Click on “Browse” and select your OPML or archive file on your computer. - 3. Click on “Import” +1. Go to the page “Import / export”. +2. Click on “Browse” and select your OPML or archive file on your computer. +3. Click on “Import” > **Important**: you can not import directly a list of feeds from a text file. > You need to convert it beforehand to _OPML_. @@ -116,11 +119,11 @@ See [SQLite export/import]( https://github.com/FreshRSS/FreshRSS/tree/edge/cli) > * [Pandoc](https://pandoc.org/) available for most systems, > * [OPML generator](https://opml-gen.ovh/) available online, > * [txt2opml](https://alterfiles.com/convert/txt/opml) available online. - + ## Use bookmarklet Bookmarklets are little scripts that you can execute to perform various tasks. FreshRSS offers a bookmarklet for subscribing to newsfeeds. - 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. +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. diff --git a/docs/en/users/05_Configuration.md b/docs/en/users/05_Configuration.md index a08a9e5fc..2002a18fe 100644 --- a/docs/en/users/05_Configuration.md +++ b/docs/en/users/05_Configuration.md @@ -15,14 +15,14 @@ Available languages are: cz, de, en, es, fr, he, it, ko, nl, oc, pt-br, ru, tr, There's no accounting for tastes, which is why FreshRSS offers eight official themes: - * *Blue Lagoon* by **Mister aiR** - * *Dark* by **AD** - * *Flat design* by **Marien Fressinaud** - * *Origine* by **Marien Fressinaud** - * *Origine-compact* by **Kevin Papst** - * *Pafat* by **Plopoyop** - * *Screwdriver* by **Mister aiR** - * *Swage* by **Patrick Crandol** +* *Blue Lagoon* by **Mister aiR** +* *Dark* by **AD** +* *Flat design* by **Marien Fressinaud** +* *Origine* by **Marien Fressinaud** +* *Origine-compact* by **Kevin Papst** +* *Pafat* by **Plopoyop** +* *Screwdriver* by **Mister aiR** +* *Swage* by **Patrick Crandol** If you can't find any themes you like, it's always possible to [create your own](../developers/04_Frontend/02_Design.md). @@ -32,10 +32,10 @@ To select a theme, simply scroll through the themes and select one that strikes Some people prefer short lines of text, while others prefer to maximize the available screen space. To satisfy the maximum number of people, it's possible to customize the width of the displayed content. There are four settings available: - * **Fine** displays content up to a maximum width of 550 pixels - * **Medium** displays content up to a maximum width of 800 pixels - * **Large** displays content up to a maximum width of 1000 pixels - * **No limit** displays the content on 100% of the available space +* **Fine** displays content up to a maximum width of 550 pixels +* **Medium** displays content up to a maximum width of 800 pixels +* **Large** displays content up to a maximum width of 1000 pixels +* **No limit** displays the content on 100% of the available space ## Article icons @@ -68,11 +68,11 @@ If you don't use those buttons because you never browse on mobile or because you ## 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. +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. +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 @@ -84,9 +84,9 @@ This will set images to load as they are viewed. This can save data, but will ca These are the global options for fetching and retaining articles from feeds. They can be overwridden by individual feed's settings. -## Maintenance +## Maintenance -This allows for purging/optimizing the current user's articles in the database. +This allows for purging/optimizing the current user's articles in the database. # Sharing @@ -99,16 +99,15 @@ By default, the sharing list is empty. To add a new item to the list, please follow the following simple steps: - 1. Select the desired sharing method in the drop-down list. - 1. Press the ```✚``` button to add it to the list. - 1. Configure the method in the list. All names can be modified in the display. Some methods need the sharing URL to be able to work properly (ex: Shaarli). - 1. Submit your changes. +1. Select the desired sharing method in the drop-down list. +1. Press the ```✚``` button to add it to the list. +1. Configure the method in the list. All names can be modified in the display. Some methods need the sharing URL to be able to work properly (ex: Shaarli). +1. Submit your changes. 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. - +1. Press the ```❌``` button next to the share method you want to remove. +1. Submit your changes. # Shortcuts @@ -120,10 +119,10 @@ Of course, if you're not satisfied with the key mapping, you can change you conf There are 4 types of shortcuts: - 1. Views: they allow switching views with ease. - 1. Navigation: they allow navigation through articles, feeds, and categories. - 1. Article actions: they allow interactions with an article, like sharing or opening it on the original web-site. - 1. Other actions: they allow other interactions with the application, like opening the user queries menu or accessing the documentation. +1. Views: they allow switching views with ease. +1. Navigation: they allow navigation through articles, feeds, and categories. +1. Article actions: they allow interactions with an article, like sharing or opening it on the original web-site. +1. Other actions: they allow other interactions with the application, like opening the user queries menu or accessing the documentation. It's worth noting that the share article action has two levels. Once you press the shortcut, a menu containing all the share options opens. To choose one share option, you need to select it by its number. When there is only one option, it's selected automatically though. @@ -142,26 +141,26 @@ 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. +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. +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** +> **TODO** ## Authentication methods ### HTTP Authentication (Apache) - 1. User control is based on the `.htaccess` file. - 2. It is best practice to place the `.htaccess` file in the `./i/` subdirectory so the API and other third party services can work. - 3. If you want to limit all access to registered users only, place the file in the FreshRSS directory itself or in a parent directory. Note that WebSub and API will not work! - 4. Example `.htaccess` file for a user "marie": +1. User control is based on the `.htaccess` file. +2. It is best practice to place the `.htaccess` file in the `./i/` subdirectory so the API and other third party services can work. +3. If you want to limit all access to registered users only, place the file in the FreshRSS directory itself or in a parent directory. Note that WebSub and API will not work! +4. Example `.htaccess` file for a user "marie": -``` +```apache AuthUserFile /home/marie/repertoire/.htpasswd AuthGroupFile /dev/null AuthName "Chez Marie" diff --git a/docs/en/users/06_Mobile_access.md b/docs/en/users/06_Mobile_access.md index 59b3d6c52..9974fb2bb 100644 --- a/docs/en/users/06_Mobile_access.md +++ b/docs/en/users/06_Mobile_access.md @@ -13,8 +13,8 @@ See the [page about the Fever compatible API](../developers/06_Fever_API.md.md) # Testing -3. Under the section “Profile”, click on the link like `https://rss.example.net/api/` next to the field “API password”. -4. Click on first link “Check full server configuration”: +1. Under the section “Profile”, click on the link like `https://rss.example.net/api/` next to the field “API password”. +2. Click on first link “Check full server configuration”: * If you get *PASS* then you are done, all is good: you may proceed to step 6. * If you get *Bad Request!* or *Not Found*, then your server probably does not accept slashes `/` that are escaped `%2F`. Proceed to step 5. * If you get any other error message, proceed to step 5. @@ -22,7 +22,7 @@ See the [page about the Fever compatible API](../developers/06_Fever_API.md.md) # Fix server configuration -5. Click on the second link “Check partial server configuration (without `%2F` support)”: +* Click on the second link “Check partial server configuration (without `%2F` support)”: * If you get `PASS`, then the problem is indeed that your server does not accept slashes `/` that are escaped `%2F`. * With Apache, remember the directive [`AllowEncodedSlashes On`](http://httpd.apache.org/docs/trunk/mod/core.html#allowencodedslashes) * Or use a client that does not escape slashes (such as EasyRSS), in which case proceed to step 6. diff --git a/docs/en/users/07_Frequently_Asked_Questions.md b/docs/en/users/07_Frequently_Asked_Questions.md index f9b6fcd61..ac04cf5f2 100644 --- a/docs/en/users/07_Frequently_Asked_Questions.md +++ b/docs/en/users/07_Frequently_Asked_Questions.md @@ -13,7 +13,8 @@ Of course, ```/i``` has a purpose! It's used for performance and usability: To increase security, FreshRSS is hosted in two sections. The first section is public (the `./p` folder) and the second section is private (everything else). Therefore the `robots.txt` file is located in the `./p` sub-folder. -As explained in the [security section](../admins/09_AccessControl.html), it's highly recommended to make only the public section available at the domain level. With that configuration, `./p` is the root folder for http://demo.freshrss.org/, thus making `robots.txt` available at the root of the application. +As explained in the [security section](../admins/09_AccessControl.html), it's highly recommended to make only the public section available at the domain level. +With that configuration, `./p` is the root folder for <https://demo.freshrss.org/>, thus making `robots.txt` available at the root of the application. The same principle applies to `favicon.ico` and `.htaccess`. |
