'Re: Review Request 118290: Streamline Comment fields of KCMs'

[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-panel-devel
Subject:    Re: Review Request 118290: Streamline Comment fields of KCMs
From:       "Christoph Feck" <christoph () maxiom ! de>
Date:       2014-05-26 10:38:08
Message-ID: 20140526103808.15632.81196 () probe ! kde ! org
[Download RAW message or body]

[Attachment #2 (multipart/alternative)]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/118290/#review58456
-----------------------------------------------------------

kcms/colors/colors.desktop
<https://git.reviewboard.kde.org/r/118290/#comment40663>

    I am not native english, but I think "Application's Color Scheme" is correct.

kcms/dateandtime/clock.desktop
<https://git.reviewboard.kde.org/r/118290/#comment40662>

    Is there a guideline for using the '&' character vs. "and"? I suggest to always \
use the word (which you also use e.g. for "Login and Logout") to make it consistent.

kcms/desktoppaths/desktoppath.desktop
<https://git.reviewboard.kde.org/r/118290/#comment40659>

    Maybe "Paths to Personal Files"?

kcms/formats/formats.desktop
<https://git.reviewboard.kde.org/r/118290/#comment40660>

    Missing comma before the "and".

kcms/kfontinst/kcmfontinst/fontinst.desktop
<https://git.reviewboard.kde.org/r/118290/#comment40661>

    Missing comma.

You could ask i18n team for shipit, because they can best decide at which point in \
time they are open to big string changes.

- Christoph Feck

On May 26, 2014, 8:49 a.m., Sebastian Kügler wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/118290/
> -----------------------------------------------------------
> 
> (Updated May 26, 2014, 8:49 a.m.)
> 
> 
> Review request for Plasma and KDE Usability.
> 
> 
> Repository: plasma-desktop
> 
> 
> Description
> -------
> 
> Streamline Comment fields of KCMs
> 
> This patch applies a common language and type-setting to the
> systemsettings modules in kde-workspace.
> 
> Considerations:
> - The comment field might repeat the name, or give more detail about the
> specific settings on this page, this makes sense with how
> systemsettings and kcmshell present it
> - Mentioning the words settings, configure, options, etc. is avoided --
> it is clear from the context that these are settings and options.
> - Title-case throughout in line with human interface guidelines, see
> http://techbase.kde.org/Projects/Usability/HIG/Capitalization
> - The comment ends up being the title, so the
> - tech slang is avoided as much as possible, but left in where really
> necessary (hi Phonon), there were a few mentions of ~"KDE Settings",
> which don't make sense in a properly branded universe.
> - I've left the Name field "mostly untouched", as that one is key for
> the user to find the right module in systemsettings' icon view and in
> the sidebars
> 
> The same treatment needs to be done for a bunch of other KCMs that we
> end up installing from other repos. This is a good start, however.
> 
> 
> Diffs
> -----
> 
> kcms/autostart/autostart.desktop 5a1048e72415d083040c970320fdca3b8d059f20 
> kcms/access/kcmaccess.desktop f859504cf914ba79841ccf39f9e28dba5a4255d3 
> kcms/bell/bell.desktop 906aff736f5a37c0c82d8a947d2938f3251ab132 
> kcms/colors/colors.desktop 409f665a30faee826dbe1d70dab7f2fa3ec46bd3 
> kcms/componentchooser/componentchooser.desktop \
> 214c4f1a879dd0d7cd39c92b4510cdd1173f737c  kcms/dateandtime/clock.desktop \
> acaca1a3423f427e6cbb930e0f1e45ca82ef5c03  kcms/desktoppaths/desktoppath.desktop \
> da351d95e254cd5ae13c266f77213ad51e96fe0a  kcms/desktoptheme/desktoptheme.desktop \
> 602f04cfd5b2cb61d561a5961ddbe517f70995c6  kcms/emoticons/emoticons.desktop \
> bbbd24a8a62e871ef1df9930f344a362f33cae58  kcms/fonts/fonts.desktop \
> 99a88c4d6ca8526dd565733dba203536ddc63589  kcms/formats/formats.desktop \
> d29d893e2fcfbc8062d789aea9c74416c4a78b37  kcms/hardware/display/display.desktop \
> 0d8b7e667637f05a34c4b573d7958e90436ec792  kcms/hardware/joystick/joystick.desktop \
> e5ff24a8b95472e926d0ae91399c0c5f5828bdeb  kcms/icons/icons.desktop \
> 1dfcf8cda7fb04f42597071070787b20b166ecb3  kcms/input/cursortheme.desktop \
> 4a5feed001082dd2dac1c574c4d584bd70e45bd4  kcms/input/mouse.desktop \
> 5df856e30f8ed7e0e39338fe12da0ac54a52f6ac  kcms/kded/kcmkded.desktop \
> 76e299dfc5f3d223577bd62c91616f0b8988f979  kcms/keyboard/kcm_keyboard.desktop \
> 01f95420e295e26520bf2eda88fbaf02c3f09a62  kcms/keys/keys.desktop \
> 30a4bc8c0fea4767bd217671f8d624d563593552  \
> kcms/kfontinst/kcmfontinst/fontinst.desktop \
> 6b1372545d5cabb560930c3dec5c9f3d1873e418  kcms/knotify/kcmnotify.desktop \
> cd25cd4dbfa2a2759eaec554c55e45fd133995ec  kcms/ksmserver/kcmsmserver.desktop \
> c461be78642e27b782f0be65d676244ca2bde80a  kcms/ksplash/ksplashthememgr.desktop \
> 711fbc335a4ccbf6e099e129302f40ed1d2929e9  kcms/launch/kcmlaunch.desktop \
> fbb3ca602f558075060f8e007ce000b4b78f8834  kcms/phonon/kcm_phonon.desktop \
> 46eecfffc93baecb7b77c0dcef32e9222abebb07  kcms/spellchecking/spellchecking.desktop \
> 92a76cfe63336a34f8f29b44b0e2ae551139a33c  \
> kcms/standard_actions/standard_actions.desktop \
> 54a3ea84fe40dea252d1925d9f07cf6f2882c848  kcms/style/style.desktop \
> fd19bc4b204ca102081629fd6132b14857c4e4bc  \
> kcms/workspaceoptions/workspaceoptions.desktop \
> 3e318660b0258c17bc7641efb1d7f1e84a1eed44  
> Diff: https://git.reviewboard.kde.org/r/118290/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Sebastian Kügler
> 
> 

[Attachment #5 (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="https://git.reviewboard.kde.org/r/118290/">https://git.reviewboard.kde.org/r/118290/</a>
  </td>
    </tr>
   </table>
   <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="https://git.reviewboard.kde.org/r/118290/diff/1/?file=274663#file274663line106" \
style="color: black; font-weight: bold; text-decoration: \
underline;">kcms/colors/colors.desktop</a>  <span style="font-weight: normal;">

     (Diff revision 1)

    </span>
   </th>
  </tr>
 </thead>

 <tbody>

  <tr>
    <th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">106</font></th>  <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; ">Comment=Change the colors used \
in applications</pre></td>  <th bgcolor="#e9eaa8" style="border-left: 1px solid \
#C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font \
size="2">106</font></th>  <td bgcolor="#fdfebc" width="50%"><pre style="font-size: \
8pt; line-height: 140%; margin: 0; ">Comment=Application Color Scheme</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 am not \
native english, but I think &quot;Application&#39;s Color Scheme&quot; is \
correct.</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="https://git.reviewboard.kde.org/r/118290/diff/1/?file=274665#file274665line107" \
style="color: black; font-weight: bold; text-decoration: \
underline;">kcms/dateandtime/clock.desktop</a>  <span style="font-weight: normal;">

     (Diff revision 1)

    </span>
   </th>
  </tr>
 </thead>

 <tbody>

  <tr>
    <th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">107</font></th>  <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; ">Comment=Configure date and \
time settings</pre></td>  <th bgcolor="#e9eaa8" style="border-left: 1px solid \
#C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font \
size="2">107</font></th>  <td bgcolor="#fdfebc" width="50%"><pre style="font-size: \
8pt; line-height: 140%; margin: 0; ">Comment=Date &amp; Time</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;">Is there a \
guideline for using the &#39;&amp;&#39; character vs. &quot;and&quot;? I suggest to \
always use the word (which you also use e.g. for &quot;Login and Logout&quot;) to \
make it consistent.</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="https://git.reviewboard.kde.org/r/118290/diff/1/?file=274666#file274666line106" \
style="color: black; font-weight: bold; text-decoration: \
underline;">kcms/desktoppaths/desktoppath.desktop</a>  <span style="font-weight: \
normal;">

     (Diff revision 1)

    </span>
   </th>
  </tr>
 </thead>

 <tbody>

  <tr>
    <th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">106</font></th>  <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; ">Comment=Change the location \
important files are stored</pre></td>  <th bgcolor="#e9eaa8" style="border-left: 1px \
solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font \
size="2">106</font></th>  <td bgcolor="#fdfebc" width="50%"><pre style="font-size: \
8pt; line-height: 140%; margin: 0; ">Comment=Paths to your Files</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;">Maybe \
&quot;Paths to Personal Files&quot;?</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="https://git.reviewboard.kde.org/r/118290/diff/1/?file=274670#file274670line27" \
style="color: black; font-weight: bold; text-decoration: \
underline;">kcms/formats/formats.desktop</a>  <span style="font-weight: normal;">

     (Diff revision 1)

    </span>
   </th>
  </tr>
 </thead>

 <tbody>

  <tr>
    <th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">27</font></th>  <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; ">Comment=Numeric, <span \
class="hl">c</span>urrency and <span class="hl">t</span>ime <span \
class="hl">f</span>ormat<span class="hl">ting settings for your particular \
region</span></pre></td>  <th bgcolor="#e9eaa8" style="border-left: 1px solid \
#C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font \
size="2">27</font></th>  <td bgcolor="#fdfebc" width="50%"><pre style="font-size: \
8pt; line-height: 140%; margin: 0; ">Comment=Numeric, <span \
class="hl">C</span>urrency and <span class="hl">T</span>ime <span \
class="hl">F</span>ormat<span class="hl">s</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;">Missing \
comma before the &quot;and&quot;.</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="https://git.reviewboard.kde.org/r/118290/diff/1/?file=274679#file274679line64" \
style="color: black; font-weight: bold; text-decoration: \
underline;">kcms/kfontinst/kcmfontinst/fontinst.desktop</a>  <span \
style="font-weight: normal;">

     (Diff revision 1)

    </span>
   </th>
  </tr>
 </thead>

 <tbody>

  <tr>
    <th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2">64</font></th>  <td bgcolor="#fdfebc" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; ">Comment=Install, manage, and \
preview fonts</pre></td>  <th bgcolor="#e9eaa8" style="border-left: 1px solid \
#C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font \
size="2">64</font></th>  <td bgcolor="#fdfebc" width="50%"><pre style="font-size: \
8pt; line-height: 140%; margin: 0; ">Comment=Font Installation, Preview and \
Removal</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;">Missing \
comma.</pre> </div>
<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;">You could ask i18n team \
for shipit, because they can best decide at which point in time they are open to big \
string changes.</pre>

<p>- Christoph Feck</p>

<br />
<p>On May 26th, 2014, 8:49 a.m. UTC, Sebastian Kügler wrote:</p>

<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" \
style="background-image: \
url('https://git.reviewboard.kde.org/static/rb/images/review_request_box_top_bg.ab6f3b1072c9.png'); \
background-position: left top; background-repeat: repeat-x; border: 1px black \
solid;">  <tr>
  <td>

<div>Review request for Plasma and KDE Usability.</div>
<div>By Sebastian Kügler.</div>

<p style="color: grey;"><i>Updated May 26, 2014, 8:49 a.m.</i></p>

<div style="margin-top: 1.5em;">
 <b style="color: #575012; font-size: 10pt;">Repository: </b>
plasma-desktop
</div>

<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;">Streamline Comment fields of KCMs

This patch applies a common language and type-setting to the
systemsettings modules in kde-workspace.

Considerations:
- The comment field might repeat the name, or give more detail about the
  specific settings on this page, this makes sense with how
  systemsettings and kcmshell present it
- Mentioning the words settings, configure, options, etc. is avoided --
  it is clear from the context that these are settings and options.
- Title-case throughout in line with human interface guidelines, see
  http://techbase.kde.org/Projects/Usability/HIG/Capitalization
- The comment ends up being the title, so the
- tech slang is avoided as much as possible, but left in where really
  necessary (hi Phonon), there were a few mentions of ~&quot;KDE Settings&quot;,
  which don&#39;t make sense in a properly branded universe.
- I&#39;ve left the Name field &quot;mostly untouched&quot;, as that one is key for
  the user to find the right module in systemsettings&#39; icon view and in
  the sidebars

The same treatment needs to be done for a bunch of other KCMs that we
end up installing from other repos. This is a good start, however.</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>kcms/autostart/autostart.desktop <span style="color: \
grey">(5a1048e72415d083040c970320fdca3b8d059f20)</span></li>

 <li>kcms/access/kcmaccess.desktop <span style="color: \
grey">(f859504cf914ba79841ccf39f9e28dba5a4255d3)</span></li>

 <li>kcms/bell/bell.desktop <span style="color: \
grey">(906aff736f5a37c0c82d8a947d2938f3251ab132)</span></li>

 <li>kcms/colors/colors.desktop <span style="color: \
grey">(409f665a30faee826dbe1d70dab7f2fa3ec46bd3)</span></li>

 <li>kcms/componentchooser/componentchooser.desktop <span style="color: \
grey">(214c4f1a879dd0d7cd39c92b4510cdd1173f737c)</span></li>

 <li>kcms/dateandtime/clock.desktop <span style="color: \
grey">(acaca1a3423f427e6cbb930e0f1e45ca82ef5c03)</span></li>

 <li>kcms/desktoppaths/desktoppath.desktop <span style="color: \
grey">(da351d95e254cd5ae13c266f77213ad51e96fe0a)</span></li>

 <li>kcms/desktoptheme/desktoptheme.desktop <span style="color: \
grey">(602f04cfd5b2cb61d561a5961ddbe517f70995c6)</span></li>

 <li>kcms/emoticons/emoticons.desktop <span style="color: \
grey">(bbbd24a8a62e871ef1df9930f344a362f33cae58)</span></li>

 <li>kcms/fonts/fonts.desktop <span style="color: \
grey">(99a88c4d6ca8526dd565733dba203536ddc63589)</span></li>

 <li>kcms/formats/formats.desktop <span style="color: \
grey">(d29d893e2fcfbc8062d789aea9c74416c4a78b37)</span></li>

 <li>kcms/hardware/display/display.desktop <span style="color: \
grey">(0d8b7e667637f05a34c4b573d7958e90436ec792)</span></li>

 <li>kcms/hardware/joystick/joystick.desktop <span style="color: \
grey">(e5ff24a8b95472e926d0ae91399c0c5f5828bdeb)</span></li>

 <li>kcms/icons/icons.desktop <span style="color: \
grey">(1dfcf8cda7fb04f42597071070787b20b166ecb3)</span></li>

 <li>kcms/input/cursortheme.desktop <span style="color: \
grey">(4a5feed001082dd2dac1c574c4d584bd70e45bd4)</span></li>

 <li>kcms/input/mouse.desktop <span style="color: \
grey">(5df856e30f8ed7e0e39338fe12da0ac54a52f6ac)</span></li>

 <li>kcms/kded/kcmkded.desktop <span style="color: \
grey">(76e299dfc5f3d223577bd62c91616f0b8988f979)</span></li>

 <li>kcms/keyboard/kcm_keyboard.desktop <span style="color: \
grey">(01f95420e295e26520bf2eda88fbaf02c3f09a62)</span></li>

 <li>kcms/keys/keys.desktop <span style="color: \
grey">(30a4bc8c0fea4767bd217671f8d624d563593552)</span></li>

 <li>kcms/kfontinst/kcmfontinst/fontinst.desktop <span style="color: \
grey">(6b1372545d5cabb560930c3dec5c9f3d1873e418)</span></li>

 <li>kcms/knotify/kcmnotify.desktop <span style="color: \
grey">(cd25cd4dbfa2a2759eaec554c55e45fd133995ec)</span></li>

 <li>kcms/ksmserver/kcmsmserver.desktop <span style="color: \
grey">(c461be78642e27b782f0be65d676244ca2bde80a)</span></li>

 <li>kcms/ksplash/ksplashthememgr.desktop <span style="color: \
grey">(711fbc335a4ccbf6e099e129302f40ed1d2929e9)</span></li>

 <li>kcms/launch/kcmlaunch.desktop <span style="color: \
grey">(fbb3ca602f558075060f8e007ce000b4b78f8834)</span></li>

 <li>kcms/phonon/kcm_phonon.desktop <span style="color: \
grey">(46eecfffc93baecb7b77c0dcef32e9222abebb07)</span></li>

 <li>kcms/spellchecking/spellchecking.desktop <span style="color: \
grey">(92a76cfe63336a34f8f29b44b0e2ae551139a33c)</span></li>

 <li>kcms/standard_actions/standard_actions.desktop <span style="color: \
grey">(54a3ea84fe40dea252d1925d9f07cf6f2882c848)</span></li>

 <li>kcms/style/style.desktop <span style="color: \
grey">(fd19bc4b204ca102081629fd6132b14857c4e4bc)</span></li>

 <li>kcms/workspaceoptions/workspaceoptions.desktop <span style="color: \
grey">(3e318660b0258c17bc7641efb1d7f1e84a1eed44)</span></li>

</ul>

<p><a href="https://git.reviewboard.kde.org/r/118290/diff/" style="margin-left: \
3em;">View Diff</a></p>

  </td>
 </tr>
</table>

  </div>
 </body>
</html>

_______________________________________________
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel

[prev in list] [next in list] [prev in thread] [next in thread] 