chore: update settings documentation

This commit is contained in:
Diego Beraldin 2024-01-28 09:47:45 +01:00
parent 1874e7bba0
commit b7f0e03132
12 changed files with 62 additions and 34 deletions

View File

@ -79,8 +79,8 @@ a query string and result type (post, comment, communities, users or everything)
In anonymous mode the profile and inbox screens are just placeholders that invite you to access with
an account.
![explore](images/anon_profile.png)
![explore](images/anon_inbox.png)
![anonymous profile](images/anon_profile.png)
![anonymous inbox](images/anon_inbox.png)
### 1.8 Settings
@ -94,20 +94,14 @@ The settings screen allows you to customize the look and behaviour of your app.
- System notification and navigation bar theme: if you enable edge-to-edge display, choosing "
Transparent" makes the status and nav bar completely transparent, otherwise they have the
system color with a slight alpha to make them more visible;
- Custom theme color: (requires "Use dynamic color" off to be applied) generate a palette by
choosing a seed color from a predefined list or custom color;
- Comment bar theme: palette of colors used to distinguish nested comments;
- UI font family: typeface used for the app UI elements (menus, labels, etc);
- Content font family: typeface used for post and comments on Lemmy;
- UI text size: scale factor to apply to the app UI elements;
- Content text size: scale factor to apply to posts and comments on Lemmy;
- Show navigation bar titles: include the section titles in the bottom navigation bar;
- Colors and fonts: opens the color and font configuration screen;
- Post and comments:
- Post layout: choose a layout (Card, Compact, Full) for posts
- Vote format: see the score of posts and comments as aggregated (`upvotes - downvotes`), split
or percentage (`upvotes / (upvotes + downvotes) * 100`);
- Full height images: show images with scaled width and full height (instead of capping the
height) in the feed;
- Show navigation bar titles: include the section titles in the bottom navigation bar;
- Post and comments:
- Default feed type: listing type for the home screen applied by default
- Default post sort type: sort type for the home, community detail and user detail applied by
default;
@ -134,11 +128,25 @@ The settings screen allows you to customize the look and behaviour of your app.
- Debug:
- Enable crash reporting: send anonymous reports about crash events;
- About this app: shows a dialog with the app versions and some useful shortcuts to reach out to
the developers or other members of the community.
the developers or other members of the community;
- User manual: opens the application manual online (this page).
![settings](images/anon_settings_1.png)
![settings](images/anon_settings_2.png)
![settings](images/anon_settings_3.png)
![settings first part](images/anon_settings_1.jpg)
![settings second part](images/anon_settings_2.jpg)
#### 1.8.1 Colors and fonts
This screen allows to configure colors and fonts of the UI:
- Custom theme color: (requires "Use dynamic color" off to be applied) generate a palette by
choosing a seed color from a predefined list or custom color;
- Comment bar theme: palette of colors used to distinguish nested comments;
- UI font family: typeface used for the app UI elements (menus, labels, etc);
- Content font family: typeface used for post and comments on Lemmy;
- UI text size: scale factor to apply to the app UI elements;
- Content text size: scale factor to apply to posts and comments on Lemmy;
![colors and fonts](images/anon_color_fonts.jpg)
### 1.9 Moderation log

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 152 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 153 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

After

Width:  |  Height:  |  Size: 63 KiB

View File

@ -61,13 +61,6 @@ additional items and sub-screens.
Please refer to [description of the page](#18-settings) for anonymous users for the common parts,
here is a description of the additional functions:
- Look and feel:
- Upvote color: color of the upvote action (both used as a card background when swiping and to
highlight the vote indicator when you have upvoted a content);
- Downvote color: color of the downvote action (both used as a card background when swiping and
to highlight the vote indicator when you have downvoted a content);
- Reply action color: card background color for the reply action;
- Save action color: card background color for the save action;
- Posts and comments:
- Default inbox type: whether the Inbox includes all contents by default of just unread ones;
- Behaviour:
@ -75,23 +68,50 @@ here is a description of the additional functions:
interaction, posts are marked as read on the fly as they become visible while scrolling;
- Enable double tap action: instead of using swipe actions, this option activated the "
double tap to like" mode some users may be familiar with from other social apps;
- Configure swipe actions: opens the configure swipe actions screen where it is possible to
assign an action to the 4 slots (two on the left side and two on the right side) of the
cards used to render post, comments and inbox items;
- Configure swipe actions: opens the configure swipe actions screen;
- Enable swipe actions: whether the swipe to left/right actions are enabled in post and comment
list, inbox and reports;
- Account settings:
- Web preferences: opens a page where you can customize some preferences associated to your
Lemmy account (similarly to what you can do on the webapp)
- Bans and filters: allows you to see what users, communities and instances you have blocked and
remove the block (these settings are tied to your Lemmy account too);
- Web preferences: allows you to edit web account preferences;
- Bans and filters: configure user/community/instance ban and filtering options.
![settings 1](images/logged_settings_1.jpg)
![settings 1](images/logged_settings_3.jpg)
![settings 1](images/logged_settings_2.jpg)
![settings 1](images/logged_swipe_actions.jpg)
![settings 1](images/logged_web_settings.jpg)
![settings 1](images/logged_ban_filter.jpg)
![settings 3](images/logged_settings_2.jpg)
![settings 2](images/logged_settings_3.jpg)
#### 2.6.1 Colors and fonts
This screen for anonymous users allows to configure custom colors for swipe actions:
- Upvote color: color of the upvote action (both used as a card background when swiping and to
highlight the vote indicator when you have upvoted a content);
- Downvote color: color of the downvote action (both used as a card background when swiping and
to highlight the vote indicator when you have downvoted a content);
- Reply action color: card background color for the reply action;
- Save action color: card background color for the save action;
![colors and fonts](images/logged_color_fonts.jpg)
#### 2.6.2 Configure swipe actions
In this screen it is possible to assign an action to the 4 slots (two on the left side and two on
the right side) of the cards used to render post, comments and inbox items.
![configure swipe actions](images/logged_swipe_actions.jpg)
#### 2.6.3 Web account settings
This screen lets you configure some preferences associated to your Lemmy account (similarly to what
you can do on the webapp).
![web settings](images/logged_web_settings.jpg)
#### 2.6.4 Ban and filter options
This screen allows you to see what users, communities and instances you have blocked and
remove the block (these settings are tied to your Lemmy account too).
![bans and filters](images/logged_ban_filter.jpg)
### 2.7 Moderation tools