From 0ba0f8f1f1ac7ab890f50e34f4f999027fd48c6b Mon Sep 17 00:00:00 2001 From: lain Date: Fri, 21 Jun 2019 12:47:54 +0200 Subject: [PATCH 01/13] Documentations: Add docs for settings. --- docs/USER_GUIDE.md | 66 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 7eaa6dcc..d3521ab8 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -83,4 +83,68 @@ You can also view posts you've favorited on your own profile, but you cannot see Due to nature of how Pleroma (backend) operates you might see old posts appear as if they are new, this is because instance just learned about that post (i.e. your instance is younger that some other ones) and someone interacted with old post. Posts are sorted by date of when they are received, not date they have been posted because it's very easy to spoof the date, so a post claiming it "was" made in year 2077 could hand at top of your TL forever. # Customization and configuration -TODO + +Clicking on the cog icon in the upper right will go to the settings screen. Here you have 4 tabs with several options to customize your experience. + +## General + +### Interface + +- Language: Here you can set the interface language. The default language is the one that you set in your browser settings. +- Hide instance-specific panel: This hides the panel in the lower left that usually contains general information about the server. + +### Timeline + +- Hide posts of muted users: If this is set, 'muting' a user will also hide their posts and not just collapse them. +- Collapse posts with subjects: This will collapse posts that contain a subject, hiding their content. Subjects are also sometimes called content warnings. +- Enable automatic streaming of new posts when scrolled to the top: With this enabled, new posts will automatically stream in when you are scrolled to the top. Otherwise, you will see a button on the timeline that will let you display the new posts. +- Pause streaming when tab is not focused: This pauses the automatic streaming that the previous option enables when the tab is out of focus. This is useful if you don't want to miss any new posts. +- Enable automatic loading when scrolled to the bottom: When this is disabled, a button will be shown on the bottom of the timeline that will let you load older posts. +- Enable reply-link preview on hover: Status posts in the timeline and notifications contain links to replies and to the post they are a reply to. If this setting is enabled, hovering over that link will display that linked post in a small hovering overlay. + +### Composing + +- Copy scope when replying: When this is activated, the scope of a reply will be the same as the scope of the post it is replying to. This is useful to prevent accidentally moving private discussions to public, or vice versa. +- Always show subject field: Whether or not to display the 'subject' input field in the post form. If you do not want to use subjects, you can deactivate this. +- Copy subject when replying: This controls if the subject of a post will be copied from the post it is replying to. +- Post status content type: Selects the default content type of your post. The options are: Plain text, HTML, BBCode and Markdown. +- Minimize scope selection options: Selecting this will reduce the visibility scopes to 'public' and 'direct'. +- Automatically hide New Post button: TODO: Not quite sure when it's hidden. + +### Attachments + +- Hide attachments in timeline: Do not display attachments in timelines. They will still display in expanded conversations. This is useful to save bandwidth and for browsing in public. +- Hide attachments in conversations: Also hide attachments in expanded conversations. +- Maximum amount of thumbnails per post: Exactly that :) +- Enable clickthrough NSFW attachment hiding: Hide attachments that are marked as NSFW/sensible behind a click-through image. +- Preload images: This will preload the hidden images so that they display faster when clicking through. +- Open NSFW attachments with just one click: Directly open NSFW attachments in a maximised state instead of revealing the image thumbnail. +- Play-on-hover GIFs: With this activated, GIFs will only play on hover. Otherwise, they will autoplay normally. +- Loop videos: Whether to loop videos indefinitely. +- Loop only videos without sound: Some instances will use videos without sounds instead of GIFs. This will make only those videos autoplay. +- Play videos directly in the media viewer: TODO: Don't know what this does. +- Don't crop the attachment in thumbnails: Selecting this will not crop the attachment thumbnails for a more uniform look, instead it will leave them in the original format. + +### Notifications + +- Enable web push notifications: This enables the web push notifications that your browser displays, even when you are not looking at your pleroma site. Pleroma's own notifications are not affected by this. + +## Theme + +Here you can change, load and save the look of your Pleroma frontend. There are a lot of options, but there is a preview. Play around with the settings and see what you like! + +TODO: Maybe expand? + +## Filtering + +- Types of notifications to show: This controls which things you will be notified about. +- Replies in timeline: You may know that other social networks like Twitter will often not display replies to other people in your timeline, even if you are following the poster. Pleroma usually will show these posts to you to encourage conversation. If you do not like this behavior, you can change it here. +- Hide post statistics: This hides the number of favorites, number of replies, etc. +- Hide user statistics: This hides the number of followers, friends, etc. +- Muted words: A list of words that will be muted (= displayed in a collapsed state) on the timeline and in notifications. An easy way to tune down noise in your timeline. Posts can always be extended when you actually want to see them. +- Hide filtered statuses: Selecting this will not only collapse the filtered / muted posts, but hide them completely. + + +## Version + +Just displays the backend and frontend version. Useful to mention in bug reports. From 9bc7b1950024d814cea76faaf79d679749f854da Mon Sep 17 00:00:00 2001 From: lain Date: Mon, 24 Jun 2019 22:06:02 +0000 Subject: [PATCH 02/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index d3521ab8..aaa028ca 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -141,7 +141,7 @@ TODO: Maybe expand? - Replies in timeline: You may know that other social networks like Twitter will often not display replies to other people in your timeline, even if you are following the poster. Pleroma usually will show these posts to you to encourage conversation. If you do not like this behavior, you can change it here. - Hide post statistics: This hides the number of favorites, number of replies, etc. - Hide user statistics: This hides the number of followers, friends, etc. -- Muted words: A list of words that will be muted (= displayed in a collapsed state) on the timeline and in notifications. An easy way to tune down noise in your timeline. Posts can always be extended when you actually want to see them. +- Muted words: A list of words that will be muted (i.e. displayed in a collapsed state) on the timeline and in notifications. An easy way to tune down noise in your timeline. Posts can always be expanded when you actually want to see them. - Hide filtered statuses: Selecting this will not only collapse the filtered / muted posts, but hide them completely. From bd8e1c9e23c11d392a5c9ac0859bd5ac7aa0372e Mon Sep 17 00:00:00 2001 From: lain Date: Mon, 24 Jun 2019 22:06:19 +0000 Subject: [PATCH 03/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index aaa028ca..3e3c79a4 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -142,7 +142,7 @@ TODO: Maybe expand? - Hide post statistics: This hides the number of favorites, number of replies, etc. - Hide user statistics: This hides the number of followers, friends, etc. - Muted words: A list of words that will be muted (i.e. displayed in a collapsed state) on the timeline and in notifications. An easy way to tune down noise in your timeline. Posts can always be expanded when you actually want to see them. -- Hide filtered statuses: Selecting this will not only collapse the filtered / muted posts, but hide them completely. +- Hide filtered statuses: Selecting this will hide the filtered / muted posts completely instead of collapsing them. ## Version From 7dfd50c7c828295c06bb8692e5f9aa12909ff628 Mon Sep 17 00:00:00 2001 From: lain Date: Mon, 24 Jun 2019 22:07:03 +0000 Subject: [PATCH 04/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 3e3c79a4..f059b2e8 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -123,7 +123,7 @@ Clicking on the cog icon in the upper right will go to the settings screen. Here - Loop videos: Whether to loop videos indefinitely. - Loop only videos without sound: Some instances will use videos without sounds instead of GIFs. This will make only those videos autoplay. - Play videos directly in the media viewer: TODO: Don't know what this does. -- Don't crop the attachment in thumbnails: Selecting this will not crop the attachment thumbnails for a more uniform look, instead it will leave them in the original format. +- Don't crop the attachment in thumbnails: if enabled, images in attachments will be fit entirely inside the container instead of being zoomed in and cropped. ### Notifications From b02a92e9f6f0e4ec971b2643289b00e0bda87b45 Mon Sep 17 00:00:00 2001 From: HJ <30-hj@users.noreply.git.pleroma.social> Date: Wed, 26 Jun 2019 11:46:13 +0000 Subject: [PATCH 05/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index f059b2e8..b89106f3 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -84,7 +84,7 @@ Due to nature of how Pleroma (backend) operates you might see old posts appear a # Customization and configuration -Clicking on the cog icon in the upper right will go to the settings screen. Here you have 4 tabs with several options to customize your experience. +Clicking on the cog icon in the upper right will go to the settings screen. ## General From 0b4c6127c5a181ce3f092d0b3211682b0952ec3b Mon Sep 17 00:00:00 2001 From: HJ <30-hj@users.noreply.git.pleroma.social> Date: Wed, 26 Jun 2019 11:46:16 +0000 Subject: [PATCH 06/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index b89106f3..5fb80f1b 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -95,7 +95,7 @@ Clicking on the cog icon in the upper right will go to the settings screen. ### Timeline -- Hide posts of muted users: If this is set, 'muting' a user will also hide their posts and not just collapse them. +- Hide posts of muted users: If this is set, 'muting' a user will completely hide their posts instead of collapsing them. - Collapse posts with subjects: This will collapse posts that contain a subject, hiding their content. Subjects are also sometimes called content warnings. - Enable automatic streaming of new posts when scrolled to the top: With this enabled, new posts will automatically stream in when you are scrolled to the top. Otherwise, you will see a button on the timeline that will let you display the new posts. - Pause streaming when tab is not focused: This pauses the automatic streaming that the previous option enables when the tab is out of focus. This is useful if you don't want to miss any new posts. From 0892c13c2c02f40ce3f81de98aa0cb3fd2720b65 Mon Sep 17 00:00:00 2001 From: HJ <30-hj@users.noreply.git.pleroma.social> Date: Wed, 26 Jun 2019 11:46:19 +0000 Subject: [PATCH 07/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 5fb80f1b..30a977a8 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -108,7 +108,7 @@ Clicking on the cog icon in the upper right will go to the settings screen. - Always show subject field: Whether or not to display the 'subject' input field in the post form. If you do not want to use subjects, you can deactivate this. - Copy subject when replying: This controls if the subject of a post will be copied from the post it is replying to. - Post status content type: Selects the default content type of your post. The options are: Plain text, HTML, BBCode and Markdown. -- Minimize scope selection options: Selecting this will reduce the visibility scopes to 'public' and 'direct'. +- Minimize scope selection options: Selecting this will reduce the visibility scopes to 'direct', your default post scope and post scope of post you're replying to. - Automatically hide New Post button: TODO: Not quite sure when it's hidden. ### Attachments From c6a29b48eba77907b877d63d05de227c94e27ef2 Mon Sep 17 00:00:00 2001 From: HJ <30-hj@users.noreply.git.pleroma.social> Date: Wed, 26 Jun 2019 11:47:26 +0000 Subject: [PATCH 08/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 30a977a8..e6750c99 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -109,7 +109,7 @@ Clicking on the cog icon in the upper right will go to the settings screen. - Copy subject when replying: This controls if the subject of a post will be copied from the post it is replying to. - Post status content type: Selects the default content type of your post. The options are: Plain text, HTML, BBCode and Markdown. - Minimize scope selection options: Selecting this will reduce the visibility scopes to 'direct', your default post scope and post scope of post you're replying to. -- Automatically hide New Post button: TODO: Not quite sure when it's hidden. +- Automatically hide New Post button: Mobile interface only: hide floating "New post" button when scrolling ### Attachments From c95a3f0a1a6fc25ab2c2132259bb0e63d11aa039 Mon Sep 17 00:00:00 2001 From: HJ <30-hj@users.noreply.git.pleroma.social> Date: Wed, 26 Jun 2019 11:47:30 +0000 Subject: [PATCH 09/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index e6750c99..e0ae06e3 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -116,7 +116,7 @@ Clicking on the cog icon in the upper right will go to the settings screen. - Hide attachments in timeline: Do not display attachments in timelines. They will still display in expanded conversations. This is useful to save bandwidth and for browsing in public. - Hide attachments in conversations: Also hide attachments in expanded conversations. - Maximum amount of thumbnails per post: Exactly that :) -- Enable clickthrough NSFW attachment hiding: Hide attachments that are marked as NSFW/sensible behind a click-through image. +- Enable clickthrough NSFW attachment hiding: Hide attachments that are marked as NSFW/sensitive behind a click-through image.` - Preload images: This will preload the hidden images so that they display faster when clicking through. - Open NSFW attachments with just one click: Directly open NSFW attachments in a maximised state instead of revealing the image thumbnail. - Play-on-hover GIFs: With this activated, GIFs will only play on hover. Otherwise, they will autoplay normally. From afb8ef19838dca1436e920494cb5af3b2df12946 Mon Sep 17 00:00:00 2001 From: HJ <30-hj@users.noreply.git.pleroma.social> Date: Wed, 26 Jun 2019 11:47:31 +0000 Subject: [PATCH 10/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index e0ae06e3..243a579c 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -119,7 +119,7 @@ Clicking on the cog icon in the upper right will go to the settings screen. - Enable clickthrough NSFW attachment hiding: Hide attachments that are marked as NSFW/sensitive behind a click-through image.` - Preload images: This will preload the hidden images so that they display faster when clicking through. - Open NSFW attachments with just one click: Directly open NSFW attachments in a maximised state instead of revealing the image thumbnail. -- Play-on-hover GIFs: With this activated, GIFs will only play on hover. Otherwise, they will autoplay normally. +- Play-on-hover GIFs: With this activated, GIFs images and avatars will only be animated on mouse hover. Otherwise, they will be always animated. This is very useful if your timeline looks too flashy from people's animated avatars and eases the CPU load. - Loop videos: Whether to loop videos indefinitely. - Loop only videos without sound: Some instances will use videos without sounds instead of GIFs. This will make only those videos autoplay. - Play videos directly in the media viewer: TODO: Don't know what this does. From 624277c40690e890477cbf91439a043e901b29d2 Mon Sep 17 00:00:00 2001 From: HJ <30-hj@users.noreply.git.pleroma.social> Date: Wed, 26 Jun 2019 11:47:48 +0000 Subject: [PATCH 11/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 243a579c..02a3e5df 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -122,7 +122,7 @@ Clicking on the cog icon in the upper right will go to the settings screen. - Play-on-hover GIFs: With this activated, GIFs images and avatars will only be animated on mouse hover. Otherwise, they will be always animated. This is very useful if your timeline looks too flashy from people's animated avatars and eases the CPU load. - Loop videos: Whether to loop videos indefinitely. - Loop only videos without sound: Some instances will use videos without sounds instead of GIFs. This will make only those videos autoplay. -- Play videos directly in the media viewer: TODO: Don't know what this does. +- Play videos directly in the media viewer: Play videos right in the timeline instead of opening it in a modal - Don't crop the attachment in thumbnails: if enabled, images in attachments will be fit entirely inside the container instead of being zoomed in and cropped. ### Notifications From 0fc04893afdb2eb353930b5fa0e6a5ba0078f281 Mon Sep 17 00:00:00 2001 From: HJ <30-hj@users.noreply.git.pleroma.social> Date: Wed, 26 Jun 2019 11:48:25 +0000 Subject: [PATCH 12/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 02a3e5df..58e88bd7 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -127,7 +127,7 @@ Clicking on the cog icon in the upper right will go to the settings screen. ### Notifications -- Enable web push notifications: This enables the web push notifications that your browser displays, even when you are not looking at your pleroma site. Pleroma's own notifications are not affected by this. +- Enable web push notifications: this enables Web Push notifications, to allow receiving notifications even when the page isn't opened, doesn't affect regular notifications. ## Theme From 3354aea356d989c42d056fe75b83e5efeef94798 Mon Sep 17 00:00:00 2001 From: HJ <30-hj@users.noreply.git.pleroma.social> Date: Wed, 26 Jun 2019 11:51:38 +0000 Subject: [PATCH 13/13] Apply suggestion to docs/USER_GUIDE.md --- docs/USER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 58e88bd7..2ba71a2c 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -137,7 +137,7 @@ TODO: Maybe expand? ## Filtering -- Types of notifications to show: This controls which things you will be notified about. +- Types of notifications to show: This controls what kind of notifications will appear in notification column and which notifications to get in your system outside the web page - Replies in timeline: You may know that other social networks like Twitter will often not display replies to other people in your timeline, even if you are following the poster. Pleroma usually will show these posts to you to encourage conversation. If you do not like this behavior, you can change it here. - Hide post statistics: This hides the number of favorites, number of replies, etc. - Hide user statistics: This hides the number of followers, friends, etc.