Difference between revisions of "Development/Getting Help"

Jump to: navigation, search
(upitty date.)
m (Text replace - "<code>" to "<syntaxhighlight lang="text">")
Line 2: Line 2:
 
Whenever you have a KDE class and want the API documentation for it (KApplication, for example), point a konqueror window to  
 
Whenever you have a KDE class and want the API documentation for it (KApplication, for example), point a konqueror window to  
  
<code>kde:KApplication</code>
+
<syntaxhighlight lang="text">kde:KApplication</code>
  
 
Be aware that the <tt>kde:</tt> konqueror shortcut only works for classes in kdelibs. If you ask for a class outside of kdelibs or a class that the API search software doesn't know about, you'll be redirected to the main API documentation page. You will need to navigate from there to find the class you're looking for.
 
Be aware that the <tt>kde:</tt> konqueror shortcut only works for classes in kdelibs. If you ask for a class outside of kdelibs or a class that the API search software doesn't know about, you'll be redirected to the main API documentation page. You will need to navigate from there to find the class you're looking for.
Line 8: Line 8:
 
If you need to look up the Qt API documentation for a class, you can point a Konqueror window to
 
If you need to look up the Qt API documentation for a class, you can point a Konqueror window to
  
<code>qt:QApplication</code>
+
<syntaxhighlight lang="text">qt:QApplication</code>
  
 
This can be done in addition to browsing the Qt documentation locally, or using Qt Assistant.
 
This can be done in addition to browsing the Qt documentation locally, or using Qt Assistant.

Revision as of 21:43, 29 June 2011

Finding documentation

Whenever you have a KDE class and want the API documentation for it (KApplication, for example), point a konqueror window to

kde:KApplication</code>
 
Be aware that the <tt>kde:</tt> konqueror shortcut only works for classes in kdelibs. If you ask for a class outside of kdelibs or a class that the API search software doesn't know about, you'll be redirected to the main API documentation page. You will need to navigate from there to find the class you're looking for.
 
If you need to look up the Qt API documentation for a class, you can point a Konqueror window to
 
<syntaxhighlight lang="text">qt:QApplication</code>
 
This can be done in addition to browsing the Qt documentation locally, or using Qt Assistant.
 
==Finding other developers==
===Mailing lists===
There are two main development mailing lists:
*The [http://mail.kde.org/mailman/listinfo/kde-devel kde-devel mailing list] for general development issues
*The [http://mail.kde.org/mailman/listinfo/kde-core-devel kde-core-devel mailing list] for development issues specific to kdelibs, kdebase, and other central development issues
 
Many other mailing lists for certain applications also existing. Before posting a question, it's always best to make sure you direct it to the right list. Emailing your question to the right list can help you get an answer faster. You can get an overview of the various available mailing lists at http://www.kde.org/mailinglists
 
===IRC===
If you're looking for something a bit more in the instant gratification department, then feel free to ask your question on IRC. KDE uses the [http://www.freenode.org Freenode] network and the easiest way to get on IRC is to point your favorite IRC client to irc.kde.org. There are several IRC clients available for KDE such as Konversation and ksirc. There are two main channels for KDE development:
*The [irc://irc.kde.org/kde-devel #kde-devel] channel for general KDE development questions
 
Additionally, there are channels for discussing the sub-frameworks of KDE 4:
*The [irc://irc.kde.org/plasma #plasma] channel for development on Plasma. The new KDE 4 desktop framework.
*The [irc://irc.kde.org/solid #solid] channel for development on Solid. The hardware detection/management framework for KDE 4.
*The [irc://irc.kde.org/phonon #phonon] channel for development on Phonon. The new KDE 4 multimedia framework.
 
As with mailing lists, many applications have their own IRC channel. However, there currently is not a list of common IRC channels available. If you need to ask a question about a specific application, check that application's home page to see if there's an IRC channel available specifically for that application. If a channel is not listed, it's best to ask your question on one of the above two general development discussion channels.
 
In order to get the most out of your IRC experience, it's best to follow these guidelines when asking questions:
 
* If you have a question, just ask it. There's no need to ask if you can ask a question.
 
* If you are going to ask a question, be specific. Don't just say "I have a problem with (this)". Explain what you've done, what the errors are, etc.
 
* Do not paste more than 4 lines of text into the channel. Use a pastebin (or the plasma pastebin widget). Examples of pastebin websites are: pastebin.org, or pastebin.ca. Then just give us the url.
 
* Be prepared to wait for an answer. Even though IRC is more real-time mode of communication, there may not be anyone available to answer your question immediately after you ask it. In general, if you don't receive a response on IRC in about an hour, it's best to send an email. 
 
* Don't ask the question more than once. Even though the channel is active, the right person may not be available to provide an answer. If you are told to wait for a certain person to come online, be sure to ask again when you see them come online. Again, if you don't receive a response to your question in about an hour, it's best to send an email.
 
==Suggested reading==
* http://developer.kde.org/~wheeler/cpp-pitfalls.html (C++-specific)
* http://edu.kde.org/development/tips.php (KDE-specific)
* http://doc.qt.nokia.com/latest/all-examples.html (Qt-specific..examples)

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal