Review Request 118290: Streamline Comment fields of KCMs

Heiko Tietze heiko.tietze at user-prompt.com
Mon May 26 22:58:02 UTC 2014



> On May 26, 2014, 10:38 a.m., Christoph Feck wrote:
> > kcms/dateandtime/clock.desktop, line 107
> > <https://git.reviewboard.kde.org/r/118290/diff/1/?file=274665#file274665line107>
> >
> >     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.
> 
> David Edmundson wrote:
>     There's a guideline on no abbreviations. I think & counts as one.
> 
> Sebastian Kügler wrote:
>     Ah, yes. Missed that one.

I added a short hint to the HIG: "Avoid abbreviations (including ampersand instead of 'and'), acronyms, and tech-babble."


- Heiko


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


On May 26, 2014, 10:52 p.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, 10:52 p.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/access/kcmaccess.desktop f859504 
>   kcms/autostart/autostart.desktop 5a1048e 
>   kcms/bell/bell.desktop 906aff7 
>   kcms/colors/colors.desktop 409f665 
>   kcms/componentchooser/componentchooser.desktop 214c4f1 
>   kcms/dateandtime/clock.desktop acaca1a 
>   kcms/desktoppaths/desktoppath.desktop da351d9 
>   kcms/desktoptheme/desktoptheme.desktop 602f04c 
>   kcms/emoticons/emoticons.desktop bbbd24a 
>   kcms/fonts/fonts.desktop 99a88c4 
>   kcms/formats/formats.desktop 8a95b61 
>   kcms/hardware/display/display.desktop 0d8b7e6 
>   kcms/hardware/joystick/joystick.desktop e5ff24a 
>   kcms/icons/icons.desktop 1dfcf8c 
>   kcms/input/cursortheme.desktop 4a5feed 
>   kcms/input/mouse.desktop 5df856e 
>   kcms/kded/kcmkded.desktop 76e299d 
>   kcms/keyboard/kcm_keyboard.desktop 01f9542 
>   kcms/keys/keys.desktop 30a4bc8 
>   kcms/kfontinst/kcmfontinst/fontinst.desktop 6b13725 
>   kcms/knotify/kcmnotify.desktop cd25cd4 
>   kcms/ksmserver/kcmsmserver.desktop c461be7 
>   kcms/ksplash/ksplashthememgr.desktop 711fbc3 
>   kcms/launch/kcmlaunch.desktop fbb3ca6 
>   kcms/phonon/kcm_phonon.desktop 46eecff 
>   kcms/spellchecking/spellchecking.desktop 92a76cf 
>   kcms/standard_actions/standard_actions.desktop 54a3ea8 
>   kcms/style/style.desktop fd19bc4 
>   kcms/workspaceoptions/workspaceoptions.desktop 3e31866 
> 
> Diff: https://git.reviewboard.kde.org/r/118290/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Sebastian Kügler
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/plasma-devel/attachments/20140526/ea86fc2a/attachment.html>


More information about the Plasma-devel mailing list