blob: 573ccca08027f5c2bbde0a123ae5c74a927213ba [file] [log] [blame] [view]
Alex Ivanov05040302020-12-23 10:09:04 +03001[En español](features.es.md) [Русский](features.ru.md)
Adrià Vilanova Martínez9fbbf162021-08-30 17:56:13 +02002 [العربية](https://docs.google.com/document/d/1QgMy4wQ0RNkreYJzaqJriXvR8xu9zI0vzoPfcDYMKU8/preview)
avm999638d8409c2020-12-07 21:46:29 +01003
4# Features
5The TW Power Tools extension offers the following features/options:
6
Adrià Vilanova Martínez2b871792021-06-09 12:35:06 +02007[TOC]
8
avm999638d8409c2020-12-07 21:46:29 +01009## Infinite scroll
10### Thread lists
11> **Option name:** _Enable infinite scrolling in thread lists_.
12
13Enables infinite scroll in thread lists in TW. This feature has already been
14added to the Community Console by Google.
15
16### Inside threads
17> **Option names:** _Automatically load batches of messages inside threads when
18scrolling down_, _Automatically load all messages at once inside threads when
19scrolling down_.
20
21Enables infinite scroll inside threads, both in TW and the Community Console.
22Both options are mutually exclusive, and depending on which one you choose, the
23feature will behave differently:
24
25- **Load batches of messages**: when scrolling to the bottom, some more messages
26will be loaded. If you scroll to the bottom again, more messages will be loaded,
27and so on.
28- **Load all messages at once**: when scrolling to the bottom, all the remaining
29messages will be loaded at once.
30
31## Additional enhancements
32### Community Console toolbar
33> **Option name:** _Fix the toolbar in thread lists in the Community Console_.
34
35Fixes the toolbar of thread lists in the Community Console so it doesn't
36disappear when scrolling down.
37
38![GIF showing the feature](resources/fix_toolbar.gif)
39
40### Redirect to the Community Console
41> **Option name:** _Redirect all threads opened in TW to the Community Console_.
42
43This feature is useful if you want the threads you open from the email
44notification link directly in the Community Console.
45
46### Profile history
47> **Option name:** _Show a "previous posts" link in user profiles_.
48
49Both in TW and the Community Console, show 2 links in user profiles, which link
50to the list of threads that the user has created/replied to in the current
51forum, and in all the forums.
52
53![Image showing the links](resources/previous_posts.jpg)
54
55### Draft messages
56> **Option name:** _Activate the `enableLoadingDraftMessages` Community Console
57flag_.
58
59Enables a Community Console flag which, when opening the reply dialog in a
60thread in the Community Console, if a draft message was saved in the Google
61servers, it is loaded in the editor.
62
63Draft messages are saved regularly into Google Servers **even if the flag is not
64enabled**, so this flag can help you recover your work from a crash, for
65example.
66
67### Contrast between read/unread threads
68> **Option name:** _Increase contrast between read and unread threads in the
69Community Console_.
70
71In thread lists in the Community Console, the backgrounds for read and unread
72threads are very similar. This option increases this contrast.
73
74### Sticky drawer headers
avm999636c1869e2021-08-09 13:24:10 +020075> **Option name:** _Make the headers in the Community Console sidebar stick at
avm999638d8409c2020-12-07 21:46:29 +010076the top_.
77
78![GIF showing the feature](resources/sticky_headers.gif)
79
80### Dark mode
81> **Option name:** _Enable the dark theme in the Community Console_.
82
83This setting lets you load a custom-built dark theme for the Community Console.
84In the options page there is a selector which lets you choose how the dark theme
85gets enabled:
86
87- **Switch in the Community Console**: a button appears at the top of the
88Community Console, which lets you switch between the light and dark themes.
89- **OS dark mode settings**: when you enable the OS wide dark mode setting (not
90available in all Operating Systems), the dark theme is enabled in the Community
91Console. Note that after you change the OS setting, you should reload the
92Community Console in order to load the corresponding theme.
93
94### Hide the Community Console drawer
95> **Option name:** _Always hide the drawer (left column) in the Community
96Console_.
97
98When opening the Community Console, the sidebar which shows the forums, filters,
99etc. will be hidden/closed by default. Useful if your screen is small.
100
avm999631f2350d2021-08-09 12:13:51 +0200101### Drag and drop links to the text editor (Chrome-only)
102> **Option name:** _Allow to drag and drop links to the Community Console text
103editor while preserving the text_.
avm999638d8409c2020-12-07 21:46:29 +0100104
105In Chrome, when drag and dropping bookmarks or Omnibox links to the Community
106Console rich text editor, the bookmark/link title gets replaced by the URL.
107This option reverses this so the text gets preserved.
108
109![Demo of the feature](resources/drag_and_drop_fix.gif)
110
111### Batch lock
112> **Option name:** _Add the option to lock multiple threads from the Community
113Console thread list_.
114
115![GIF showing how the feature works](resources/batch_lock.gif)
116
avm99963698d3762021-02-16 01:19:54 +0100117### More prominent announcements dot
118> **Option name:** _Show the announcements notification dot more prominently in
119the Community Console_.
120
121When this option is enabled, the "Alpha" banner in the upper-left corner of the
122Community Console is removed, and the notification dot which appears in the
avm99963d98126f2021-02-17 10:44:36 +0100123hamburger menu when there's a new announcement is enlarged and animated so you
avm99963698d3762021-02-16 01:19:54 +0100124don't miss it.
125
126![GIF showing the improved notification dot](resources/announcement_dot.gif)
127
avm99963d98126f2021-02-17 10:44:36 +0100128### Reposition the expand thread button
129> **Option name:** _Place the "expand thread" button all the way to the left in
130the Community Console thread lists_.
131
132![Picture showing the feature](resources/reposition_expand_thread.jpg)
133
avm999636c1869e2021-08-09 13:24:10 +0200134### Avatars in thread lists
135> **Option name:** _Show avatars in thread lists in the Community Console_.
136
137When this option is enabled, in thread lists in the Community Console avatars
138will be shown next to each thread to show the avatars of the people who have
139participated in the thread.
140
141The extension retrieves the main message and the first 15 replies, and shows
142the avatars in order (the first avatar corresponds to the first person who
143joined the thread). If a user hasn't set an avatar, it is skipped, and only up
144to 3 avatars are shown.
145
146#### Known issues
147- Avatars aren't shown for threads in private forums, due to technical reasons.
148- Only the main message and the first 15 replies are considered in each thread,
149so if someone joins the thread after this limit, their avatar won't appear.
150- When going back from a thread to the thread list by clicking the "back"
151button, avatars take some seconds to appear.
152- If more than 3 people with avatar have posted a message, the extension will
153not indicate this in any way, it will just show the first 3 avatars.
154- Even if a PE is not badged in a forum, their avatar will be shown in the
155thread list (this is actually a feature, not an issue). The avatar won't show
156however inside the thread.
157- If a PE changes their avatar, you might still see the old one in the thread
158list, due to the fact that avatars are stored in a cache, and are only updated
159when a new reply is posted in the thread.
160
161![Picture showing the thread list avatars feature](resources/thread_list_avatars.jpg)
162
Adrià Vilanova Martínez2a99c242021-09-07 12:44:16 +0200163### Notification when a thread list receives updates
164> **Option name:** _Show a notification in the Community Console when a thread
165list has new updates._
166
167This feature checks whether there are new threads in the current thread list
168every 3 minutes, and notifies you when there are new threads at the top of the
169list. The notification is a "soft notification": it notifies you by adding some
170exclamation marks (`[!!!]`) at the beginning of the tab title, and by showing a
171snackbar in the page, as you can see in the following screenshot:
172
173![Picture showing the soft notification](resources/auto_refresh_list.jpg)
174
175It notifies you with a soft notification instead of an actual notification
176because this way you can control when you want to participate in the forums or
177not. If you're not paying attention to the Community Console tab, you won't be
178bothered.
179
180This feature only works in the Community Console, not in the public forums, and
181only when the sort settings are set to "Sort by: Last Updated" and descending
182order. The bell icon next to the sort settings will indicate whether the sort
183settings are correct (and thus this feature is working) or not.
184
Adrià Vilanova Martínez9d27c212021-12-05 13:54:10 +0100185### Limit the height of inline images
186> **Option name:** _Prevent inline images in messages from being taller than the
187current window._
188
189It is a common case that users upload high resolution screenshots of their
190phone, which results in a very tall image being shown in the forum. This
191feature adds a custom style to set a maximum height for images inside forum
192messages, so they aren't taller than the current viewport.
193
Adrià Vilanova Martínezc2dda662022-01-09 00:29:45 +0100194### Block draft messages from being saved in Google servers
195> **Option name:** _Block the sending of your replies as you type to Google
196servers in the Community Console._
197
198The Community Console has a feature which lets users save in Google servers
199regular drafts of the message they're typing in a reply box, so they can recover
200it later on (for instance if their computer crashes).
201
202In theory, this feature is controlled by the flag called
203`enableLoadingDraftMessages`, which is disabled by default. However, even if
204this flag is disabled, the Community Console keeps saving (and deleting) the
205draft message (see [this video](https://drive.avm99963.com/s/AdEBZRDCye15aU3)).
206Thus, the only thing that changes the flag is whether the saved draft message is
207attempted to be recovered or not.
208
209This option blocks all these requests to save/delete/retrieve draft messages, so
210the feature is effectively disabled.
211
Adrià Vilanova Martínez8c6ce3e2022-02-01 14:24:41 +0100212### Per-forum activity in profiles
213> **Option name:** _Show per-forum activity in profiles in the Community
214Console._
215
216An image is worth a thousand words:
217
218![Animated GIF showing the feature](resources/per_forum_activity_chart.gif)
219
Adrià Vilanova Martínez849ede62022-06-20 19:10:28 +0200220### Thread page design in the Community Console
221> **Option name:** _Show the old/new thread page design in the Community
222Console._
223
224This option lets you force the old or new thread page design in the Community
225Console. The old thread page design was exclusive to the Console, while the new
226one has the same design of the public TW thread pages.
227
Adrià Vilanova Martínez5a8055b2022-09-29 13:05:19 +0200228#### Known issues
229The TW team is currently testing the new nested replies feature in some
230threads/forums. However, the way how threads with nested replies are represented
231internally is different than before, and this causes the old design to not load
232these type of threads correctly.
233
234This is why when the user chooses the old UI, the extension now shows a warning
235banner in these threads to make them aware of why the thread doesn't look right.
236
237A possible way to work around this is to load these affected threads via TW
238Basic instead of the Community Console. Otherwise, you might have to disable the
239old UI temporarily from the options page and reload the Community Console to
240view them via the new UI.
241
avm999634ba9dd62022-08-22 20:29:04 +0200242### Reduce whitespace
243> **Option name:** _Reduce the whitespace in the Community Console and TW._
244
245This option reduces excessive whitespace throughout the Community Console and TW
246Basic, as shown in the screenshots below:
247
248![Picture showing the difference between the feature enabled or disabled when viewing a thread](resources/ui_spacing.png)
249
250It also reduces whitespace in thread lists in small screens so the titles fit
251better and can be read:
252
253![Picture showing how whitespace is reduced in the thread list page in mobile](resources/ui_spacing_2.png)
254
Adrià Vilanova Martínezb0f05312023-04-13 00:08:12 +0200255### Flatten threads
256> **Option name:** _Show a toggle to enable/disable nested view in threads._
257
258This option shows a toggle in threads just below the main post which lets you
259switch between the vanilla nested view and a new view which shows all replies
260in a linear non-nested view, just like before.
261
262![Animated GIF showing how the feature is used](resources/flatten_threads.gif)
263
Adrià Vilanova Martínez2b871792021-06-09 12:35:06 +0200264## Indicator dot
avm999638d8409c2020-12-07 21:46:29 +0100265> **Option names:** _Show whether the OP has participated in other threads_,
266_Show the number of questions and replies written by the OP within the last `n`
267months next to their username_.
268
269This section includes options which are useful to determine whether an OP is a
270newcomer or has posted in the forums before. A full description of what each
271option does can be found at [docs/op\_indicator.md](op_indicator.md).
272
273These are the possible combinations of both options:
274
275- 1st option enabled, 2nd option disabled.
276
277![Picture showing a colored dot next to the username](resources/op_indicator_1.gif)
278
279- 1st option disabled, 2nd option enabled.
280
281![Picture showing a monochrome badge](resources/op_indicator_2.gif)
282
283- Both options enabled.
284
285![Picture showing a colored badge](resources/op_indicator_3.gif)