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