Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for feed options and settings for the web-ui #3041

Merged
merged 1 commit into from
Jan 10, 2025
Merged

docs: add documentation for feed options and settings for the web-ui #3041

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 92 additions & 3 deletions docs/user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,102 @@

Welcome to the User documentation of News.

# TODO
# TODO
This documentation is work in progress.

# User interface

explain the different options in the UI especially options for feeds and settings
## Feed Update Errors
If a feed fails to update eight times in a row, the interface displays a red bubble at the feed showing the number of errors since the last successful update.
When hovering the mouse pointer over the red bubble, the last error message is displayed.

## Feed options

### Mark Read
Mark the feed as read.

### Pin to Top/Unpin from Top
The feed will be displayed at the top of the list.

### Default Order/Newest First/Oldest First
Sets the sorting order for displaying this feed. The default order is set in the settings.
**Note**: For technical reasons, the sorting is based on the date the article was added to the database, not the publication date.

### Enable/Disable Full Text
When enabled, articles will be fully retrieved from the website during the next fetch, instead of using the RSS feed.

### Unread/Ignore Updated
- If **Unread Updated** is selected, previously read articles will be marked as unread when updated.
- Otherwise, changes to articles will be ignored.

### Rename
Rename the feed.

### Move
Move the feed to a different location.

### Delete
Delete the feed.

### Open Feed URL
Open the feed in a new tab or window.

## Settings

### Keyboard Shortcuts
Displays the keys for keyboard navigation.

### Article Feed Information
Opens a table with information about the article feeds:
- **Last update**: Time when the feed was last downloaded.
- **Next update**: Time when the next feed update will be done.
(Only if activated in the admin settings, otherwise the regular update interval is used.)
- **Articles per update**: Maximum number of articles reached in a feed update.
- **Error Count**: Number of errors that have occurred since the last successful feed update.
(When hovering the mouse pointer over the error count in a row, the last error message is displayed.)

### Display mode

- **Default Mode**:
Displays the title and preview text across multiple lines per row.

- **Compact Mode**:
Depending on the split mode, the title and preview text are displayed on a single line per row.

- **Screen Reader Mode**:
A specialized mode optimized for text-to-speech programs (e.g., Orca).
In this mode, visual elements are not relevant.
Key features:
- Keyboard navigation focuses on the article link when switching between articles.
- During tab navigation, changing the article automatically selects the newly focused article.

### Split mode

- **Vertical**:
The default three-column layout, with navigation, article list, and article displayed side by side.

- **Horizontal**:
Navigation on the left, with the article list and article stacked vertically on the right.

- **Off**:
A two-row layout where navigation and the article list are side by side. The selected article is displayed over the article list.

### Disable Mark Read Through Scrolling
Articles are not marked as read while scrolling.

### Show All Articles
All available articles are always displayed.

### Reverse Ordering (Oldest on Top)
Reverses the order so that older articles are displayed first.
**Note**: For technical reasons, the sorting is based on the date the article was added to the database, not the publication date.

### Disable Automatic Refresh
This option disables automatic feed synchronization with the backend, which occurs every 60 seconds.

### Abonnements (OPML)

Check failure on line 98 in docs/user.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Abonnements'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Abonnements'?", "location": {"path": "docs/user.md", "range": {"start": {"line": 98, "column": 5}}}, "severity": "ERROR"}
Feed lists in OPML format can be imported and exported here. Feeds that cannot be loaded during the import will be ignored.

# Using News with Clients

explain sync and link to clients page
explain sync and link to clients page
Loading