[KDE Dot News]
 faq
 flatforty
 contribute
 subscribe
 configure
 search
 rdf

 main


  Aaron J. Seigo: Adding WhatsThis Help To KDE Applications
Developer Posted by Aaron J. Seigo on Sunday 17/Aug/2003, @23:08
from the do-it-yourself dept.
Adding WhatsThis Help To KDE Applications is the first installment in the Non-Programmer's Guide to Participating in KDE tutorial series. This series is designed to aid those who would like to participate in the KDE project, but for one reason or another can't do so by contributing source code. Fortunately, there are many tasks in KDE that don't involve writing code, and many of them don't require much investment in the way of time, either. Adding WhatsThis help in KDE is one such task.

WhatsThis help is essentially an on-demand, extended tooltip associated with a specific widget. It tends to be more verbose than a tooltip, but more succinct and specific than a full-blown help manual. To learn how to help improve KDE by adding WhatsThis entries where they are missing, check out the tutorial!

<  |  >

 

  Related Links
 ·   Articles on Developer
 ·   Also by Aaron J. Seigo
 ·   Contact author

Thread Threshold:

The Fine Print: The following comments are owned by whomever posted them.
( Reply )

Over 40 comments listed. Printing out index only.
Congratulations
by Thorsten on Monday 18/Aug/2003, @01:19
Congratulations for a great tutorial Aaron!

Cheers,
Thorsten
[ Reply To This | View ]
Non-Programmer's Guide to Participating in
by Gerd on Monday 18/Aug/2003, @01:20
Useful!

Why doesn't KDE provide a Wiki structure for documentation and a distributed framework for documentation translation ("grid translation").

non-programmer contributors don't know CVS and don't want to learn how to handle it. they will probably be even unable to use ftp and understand the docbook-format
[ Reply To This | View ]
This helps me help!
by Kurt Pfeifle on Monday 18/Aug/2003, @01:39
Thanks for that! I was looking into means to contribute "What's this?" bits and pieces anyway. So this is definitely s.th. I will look into. To have a *complete*, and I *mean* complete, 100%, working "What's this?" for *all* apps will bring KDE much closer to a viable corporate-used desktop system than anything else...

Cheer,
Kurt
[ Reply To This | View ]
Wow, a great effort
by Robert Guthrie on Monday 18/Aug/2003, @01:58
It is an impressive tutorial, and it makes sence to me as a programmer.. but i dont see anyone putting in that much effort each.. there is alot of stuff there that a small webscript can smplify (the 80 char's a line stuff for instance)

i agree with the other posters, and think that putting this effort into a web script to collect these strings, and a system to float the good ones to the top so programmers can enter them into CVS would be a better use of time..

Actually.. i take back some of what i said.. Parts of this tutorial are not misguided at all.., and incombination with a webscript idea could provide a really good soution i think...

sorry if some of this dosnt make sence, ive just felt the flu coming on, and im about to go lie down.
[ Reply To This | View ]
Help?
by konqi on Monday 18/Aug/2003, @02:08
Good stuff, altough perhaps still a bit too much from a programmers perspective, like said above.
Still a good try though.

>> It tends to be more verbose than a tooltip, but more succinct and specific than a full-blown help manual.

I actually never ever use that silly help button that unnecessarily adds bloat to every dialog.

If I want to know what a specific UI part does, it makes no sense to browse through a complete manual (I already forgot what I was looking for when I finally found the text that explains what the UI does).

If only that button could be removed from the dialogs.. /me would be a happy KDE user.
[ Reply To This | View ]
programmer oriented?
by Aaron J. Seigo on Monday 18/Aug/2003, @02:45
so, several people have noted that they think it's still all too programmer oriented. well, it's not going to get much clearer than what's there. WhatsThis help is embedded RIGHT IN the application. it isn't some external file. so you need to enter it RIGHT IN the application's source code. fortunately we have UI files to blunt that pain. =)

as for using CVS, it's not very hard. all the commands are right there to copy 'n paste, and there's even a GUI for it, as noted in one of the Tips. CVS is simply the only practical way to make patches and have the latest code. the effort required to get CVS going to do WhatsThis is minimal compared to the effort of actually writing the WhatsThis help.

as for watching how you format your lines when editting source code files, well, that's just an unfortunate detail. if wrapping at 80 characters is beyond you, or you can't be bothered to try even a little bit, stick to the UI files where it's all handled for you.

as for using a webscript, i'll just repeat this: it's embedded in the applications!

there is a UI-files-from-CVS web-based browser in the works, but it isn't ready for prime time yet. once that is done, the you can grab UI files using your web browsing and edit them from there. but this still doesn't help with making the patches or ensuring they are up-to-date when you finish.

honestly, if it's all too much effort for you, that's cool. don't do anything. just continue to be a user that takes what is made for you. i'm not trying to convert the entire world into being KDE contributors. but there ARE people out there who want to get involved, and these sorts of things are exactly what they have been asking for.

of course, i'd be happy to see a tutorial showing how to do WhatsThis that meets the "doesn't suck because it wasn't written by a programmer" standards. ;-)

also note that some of the future tutorials in this series will not have anything to do with the source code... future topics may include bug triage, icons and other art, documentation writing, translating, user support, advocacy... bug triage is likely the next one, actually...
[ Reply To This | View ]
German Translation
by German on Monday 18/Aug/2003, @03:25
Is it planned to translate this tutorial ?
It would very nice !
Or is there a way that people don`t speak english to help the kde projekt?
[ Reply To This | View ]
Great Article!
by Strider on Monday 18/Aug/2003, @08:38
This is a ridiculously useful article that has already had some broad appeal to non-programmers. Many non-programmers I know want to _do_ development but don't feel like they are actually part of the development process by writing howto's and making websites. This gives users a way to actually submit patches, make diffs, and get credit for code changes..

This little tutorial may do more to help out KDE than the last day or two of bug fixes. Thanks for adding hundreds to the pool of possible KDE developers.

Strid...
[ Reply To This | View ]
kde webpage
by KDE User on Monday 18/Aug/2003, @11:39
wouldn't people like it to be as slick as gnome.org or at least as es.kde.org
[ Reply To This | View ]
Thanks for this great article/howto
by John Herdy on Wednesday 20/Aug/2003, @03:31
See title, just want to show my appreciation.
[ Reply To This | View ]
Thanks for this great article/howto
by John Herdy on Wednesday 20/Aug/2003, @03:31
See title, just want to show my appreciation.
[ Reply To This | View ]
GREAT GUIDE!
by Mario on Saturday 23/Aug/2003, @10:13
This is one area where KD Eis clearly lacking and now anybody can add more helpful What'sThisHelp to KDE with a bit of work.

Thank you!

BTW: While this wish http://bugs.kde.org/show_bug.cgi?id=59859 would not be encessary if every part of KDE's inteface had a What'sThis tooltip, that probably won't happen so we still need a way to make the user know wher ethe tooltips are. For example when he clicks the tooltip icon and he hovers over widgets with tooltips, his mouse cursor should change so he would know that there is a tooltip there.

Vote for this bug: http://bugs.kde.org/show_bug.cgi?id=59859 and maybe Trolltech will fix it.
[ Reply To This | View ]
The Fine Print: The previous comments are owned by whomever posted them.
( Reply )

  "coffee? kde developers drink tea ;)" -- Dirk Mueller
KDE®, "K Desktop Environment", "KDE Dot News", "got the dot?" and the KDE Logo® are trademarks or registered trademarks of KDE e.V. in the European Union, the United States and other countries. All other trademarks and copyrights on this page are owned by their respective owners. Comments are owned by the poster. The rest: Copyright © 2000-2008 KDE e.V. for The KDE Project. For further information or comments on this site, please contact the Webmaster.
[ home | post article | flat forty | subscribe | search | rdf ]