[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-core-devel
Subject: Re: Review Request: Define tooltips for kdeui standard actions
From: "David Jarvie" <djarvie () kde ! org>
Date: 2012-05-13 23:46:14
Message-ID: 20120513234614.27597.18338 () vidsolbach ! de
[Download RAW message or body]
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://git.reviewboard.kde.org/r/104934/#review13793
-----------------------------------------------------------
Good idea! A couple of quick comments follow.
kdeui/actions/kstandardaction_p.h
<http://git.reviewboard.kde.org/r/104934/#comment10944>
"Discard" might be a bit more understandable and less technical term.
kdeui/actions/kstandardaction_p.h
<http://git.reviewboard.kde.org/r/104934/#comment10942>
I doubt whether "elements" will necessarily be understandable to a non-=
tech user in all circumstances, especially when it's just a block of text.
kdeui/actions/kstandardaction_p.h
<http://git.reviewboard.kde.org/r/104934/#comment10943>
"Elements" is too technical a term to necessarily be understandable to =
a non-tech user in all circumstances, especially when it just refers to a b=
lock of text.
- David Jarvie
On May 13, 2012, 10:08 p.m., Aur=C3=A9lien G=C3=A2teau wrote:
> =
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/104934/
> -----------------------------------------------------------
> =
> (Updated May 13, 2012, 10:08 p.m.)
> =
> =
> Review request for kdelibs.
> =
> =
> Description
> -------
> =
> Attached patch tries to define tooltips for most of kdeui standard action=
s. The goal of this change is to try to bring value to the tooltips of tool=
bar buttons, instead of simply repeating the button text (I wrote a blog po=
st about this: http://agateau.com/2012/05/11/common-user-interface-mistakes=
-in-kde-applications-part-5-big-toolbars/ ).
> =
> I tried to come up with tooltips which would remain generic enough in a w=
ide range of contexts, but couldn't find generic-enough tooltips for every =
actions. In this case I left the tooltip empty, which cause QToolButton to =
use the action text as tooltip, as before.
> =
> If you have suggestions for the missing tooltips or corrections to the to=
oltips I came up with (I am not a native english speaker), please comment.
> =
> =
> Diffs
> -----
> =
> kdeui/actions/kstandardaction.cpp 2312cc1 =
> kdeui/actions/kstandardaction_p.h f6e6ae7 =
> kdeui/actions/ktogglefullscreenaction.cpp 8d03d6e =
> =
> Diff: http://git.reviewboard.kde.org/r/104934/diff/
> =
> =
> Testing
> -------
> =
> Tested with a few KDE applications: KWrite, Kate, Dolphin, Gwenview. Chec=
ked improved tooltips are shown and code still falls back to action text if=
no tooltip is defined.
> =
> =
> Thanks,
> =
> Aur=C3=A9lien G=C3=A2teau
> =
>
[Attachment #3 (text/html)]
<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="8" style="border: 1px #c9c399 \
solid;"> <tr>
<td>
This is an automatically generated e-mail. To reply, visit:
<a href="http://git.reviewboard.kde.org/r/104934/">http://git.reviewboard.kde.org/r/104934/</a>
</td>
</tr>
</table>
<br />
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Good idea! A couple of \
quick comments follow.</pre> <br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://git.reviewboard.kde.org/r/104934/diff/1/?file=64195#file64195line48" \
style="color: black; font-weight: bold; text-decoration: \
underline;">kdeui/actions/kstandardaction_p.h</a> <span style="font-weight: \
normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="4"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
">namespace KStandardAction</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">48</font></th> <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="p">{</span> \
<span class="n">Revert</span><span class="p">,</span> <span \
class="n">KStandardShortcut</span><span class="o">::</span><span \
class="n">Revert</span><span class="p">,</span> <span \
class="s">"file_revert"</span><span class="p">,</span> <span \
class="n">I18N_NOOP</span><span class="p">(</span><span \
class="s">"Re&vert"</span><span class="p">),</span> <span \
class="mi"><span class="hl">0</span></span><span class="p">,</span> <span \
class="s">"document-revert"</span> <span class="p">},</span></pre></td> \
<th bgcolor="#e9eaa8" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">48</font></th> <td bgcolor="#fdfebc" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span \
class="p">{</span> <span class="n">Revert</span><span class="p">,</span> <span \
class="n">KStandardShortcut</span><span class="o">::</span><span \
class="n">Revert</span><span class="p">,</span> <span \
class="s">"file_revert"</span><span class="p">,</span> <span \
class="n">I18N_NOOP</span><span class="p">(</span><span \
class="s">"Re&vert"</span><span class="p">),</span> <span \
class="n"><span class="hl">I18N_NOOP</span></span><span class="p"><span \
class="hl">(</span></span><span class="s"><span class="hl">"Revert unsaved \
changes made to document"</span></span><span class="p"><span \
class="hl">)</span>,</span> <span class="s">"document-revert"</span> <span \
class="p">},</span></pre></td> </tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">"Discard" might be a bit more understandable and less \
technical term.</pre> </div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://git.reviewboard.kde.org/r/104934/diff/1/?file=64195#file64195line62" \
style="color: black; font-weight: bold; text-decoration: \
underline;">kdeui/actions/kstandardaction_p.h</a> <span style="font-weight: \
normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="4"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
">namespace KStandardAction</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">62</font></th> <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="p">{</span> \
<span class="n">SelectAll</span><span class="p">,</span> <span \
class="n">KStandardShortcut</span><span class="o">::</span><span \
class="n">SelectAll</span><span class="p">,</span> <span \
class="s">"edit_select_all"</span><span class="p">,</span> <span \
class="n">I18N_NOOP</span><span class="p">(</span><span class="s">"Select \
&All"</span><span class="p">),</span> <span class="mi"><span \
class="hl">0</span></span><span class="p">,</span> <span \
class="s">"edit-select-all"</span> <span class="p">},</span></pre></td> \
<th bgcolor="#e9eaa8" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">62</font></th> <td bgcolor="#fdfebc" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span \
class="p">{</span> <span class="n">SelectAll</span><span class="p">,</span> <span \
class="n">KStandardShortcut</span><span class="o">::</span><span \
class="n">SelectAll</span><span class="p">,</span> <span \
class="s">"edit_select_all"</span><span class="p">,</span> <span \
class="n">I18N_NOOP</span><span class="p">(</span><span class="s">"Select \
&All"</span><span class="p">),</span> <span class="n"><span \
class="hl">I18N_NOOP</span></span><span class="p"><span \
class="hl">(</span></span><span class="s"><span class="hl">"Select all \
elements"</span></span><span class="p"><span class="hl">)</span>,</span> <span \
class="s">"edit-select-all"</span> <span class="p">},</span></pre></td> \
</tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">I doubt \
whether "elements" will necessarily be understandable to a non-tech user in \
all circumstances, especially when it's just a block of text.</pre> </div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://git.reviewboard.kde.org/r/104934/diff/1/?file=64195#file64195line62" \
style="color: black; font-weight: bold; text-decoration: \
underline;">kdeui/actions/kstandardaction_p.h</a> <span style="font-weight: \
normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="4"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
">namespace KStandardAction</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">62</font></th> <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="p">{</span> \
<span class="n">SelectAll</span><span class="p">,</span> <span \
class="n">KStandardShortcut</span><span class="o">::</span><span \
class="n">SelectAll</span><span class="p">,</span> <span \
class="s">"edit_select_all"</span><span class="p">,</span> <span \
class="n">I18N_NOOP</span><span class="p">(</span><span class="s">"Select \
&All"</span><span class="p">),</span> <span class="mi"><span \
class="hl">0</span></span><span class="p">,</span> <span \
class="s">"edit-select-all"</span> <span class="p">},</span></pre></td> \
<th bgcolor="#e9eaa8" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">62</font></th> <td bgcolor="#fdfebc" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span \
class="p">{</span> <span class="n">SelectAll</span><span class="p">,</span> <span \
class="n">KStandardShortcut</span><span class="o">::</span><span \
class="n">SelectAll</span><span class="p">,</span> <span \
class="s">"edit_select_all"</span><span class="p">,</span> <span \
class="n">I18N_NOOP</span><span class="p">(</span><span class="s">"Select \
&All"</span><span class="p">),</span> <span class="n"><span \
class="hl">I18N_NOOP</span></span><span class="p"><span \
class="hl">(</span></span><span class="s"><span class="hl">"Select all \
elements"</span></span><span class="p"><span class="hl">)</span>,</span> <span \
class="s">"edit-select-all"</span> <span class="p">},</span></pre></td> \
</tr>
<tr>
<th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">63</font></th> <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="p">{</span> \
<span class="n">Deselect</span><span class="p">,</span> <span \
class="n">KStandardShortcut</span><span class="o">::</span><span \
class="n">Deselect</span><span class="p">,</span> <span \
class="s">"edit_deselect"</span><span class="p">,</span> <span \
class="n">I18N_NOOP</span><span class="p">(</span><span \
class="s">"Dese&lect"</span><span class="p">),</span> <span \
class="mi"><span class="hl">0</span></span><span class="p">,</span> <span \
class="mi">0</span> <span class="p">},</span></pre></td> <th bgcolor="#e9eaa8" \
style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">63</font></th> <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="p">{</span> \
<span class="n">Deselect</span><span class="p">,</span> <span \
class="n">KStandardShortcut</span><span class="o">::</span><span \
class="n">Deselect</span><span class="p">,</span> <span \
class="s">"edit_deselect"</span><span class="p">,</span> <span \
class="n">I18N_NOOP</span><span class="p">(</span><span \
class="s">"Dese&lect"</span><span class="p">),</span> <span \
class="n"><span class="hl">I18N_NOOP</span></span><span class="p"><span \
class="hl">(</span></span><span class="s"><span class="hl">"Deselect any \
selected elements"</span></span><span class="p"><span \
class="hl">)</span>,</span> <span class="mi">0</span> <span \
class="p">},</span></pre></td> </tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">"Elements" is too technical a term to necessarily be \
understandable to a non-tech user in all circumstances, especially when it just \
refers to a block of text.</pre> </div>
<br />
<p>- David</p>
<br />
<p>On May 13th, 2012, 10:08 p.m., Aurélien Gâteau wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" \
style="background-image: \
url('http://git.reviewboard.kde.org/media/rb/images/review_request_box_top_bg.png'); \
background-position: left top; background-repeat: repeat-x; border: 1px black \
solid;"> <tr>
<td>
<div>Review request for kdelibs.</div>
<div>By Aurélien Gâteau.</div>
<p style="color: grey;"><i>Updated May 13, 2012, 10:08 p.m.</i></p>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" \
style="border: 1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">Attached patch tries to define tooltips for most of kdeui standard \
actions. The goal of this change is to try to bring value to the tooltips of toolbar \
buttons, instead of simply repeating the button text (I wrote a blog post about this: \
http://agateau.com/2012/05/11/common-user-interface-mistakes-in-kde-applications-part-5-big-toolbars/ \
).
I tried to come up with tooltips which would remain generic enough in a wide range of \
contexts, but couldn't find generic-enough tooltips for every actions. In this \
case I left the tooltip empty, which cause QToolButton to use the action text as \
tooltip, as before.
If you have suggestions for the missing tooltips or corrections to the tooltips I \
came up with (I am not a native english speaker), please comment.</pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">Tested with a few KDE applications: KWrite, Kate, Dolphin, Gwenview. \
Checked improved tooltips are shown and code still falls back to action text if no \
tooltip is defined.</pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>kdeui/actions/kstandardaction.cpp <span style="color: \
grey">(2312cc1)</span></li>
<li>kdeui/actions/kstandardaction_p.h <span style="color: \
grey">(f6e6ae7)</span></li>
<li>kdeui/actions/ktogglefullscreenaction.cpp <span style="color: \
grey">(8d03d6e)</span></li>
</ul>
<p><a href="http://git.reviewboard.kde.org/r/104934/diff/" style="margin-left: \
3em;">View Diff</a></p>
</td>
</tr>
</table>
</div>
</body>
</html>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic