Difference between revisions of "Development/Tutorials"

Jump to: navigation, search
(Getting started)
(port tutorials index page. Links still point to the original pages. There seem to be a lot of outdated content, which should be checked again for QA.)
Line 1: Line 1:
==Getting started==
+
Tutorials are the fastest way of finding out what KDE will do for you, and how to do it. Here is a list of currently available tutorials.
  
* [[/Programming Tutorial KDE 3|Programming Tutorial for KDE 3]]
+
== Getting started ==
  
* [[/Programming Tutorial KDE 4|Programming Tutorial for KDE 4]]
+
;[[/Using Subversion with KDE|Using Subversion with KDE]]
You are interested in writing applications for KDE 4? Here you get at tutorial which leads you from the beginners stuff to the advanced techniques.
+
:''A quick KDE-specific introduction how to work with KDE's version control system''
  
* [[/Debugging|Debug your application]]
+
;[http://women.kde.org/articles/tutorials.php Coding with Qt and KDE]
 +
:Two tutorials introducing KDE and Qt brought to you by KDE-Women.
 +
 
 +
;[http://devel-home.kde.org/~larrosa/tutorial/index.html KDE 3.0 Tutorial]
 +
:''An excellent tutorial by KDE developer Antonio Larrosa Jiménez leading you from nothing to a fairly full featured web browser. Highly recommended for KDE 3.0 developers.''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/khello/khello.htm A KDE tutorial, KHello]
 +
:''A KDE 2 programming tutorial by Daniel Marjamäki. This tutorial introduces the KDE APIs using a graphical version of the world famous 'hello world' program. This document is also available in single [http://developer.kde.org/documentation/tutorials/khello/khello.tar.gz download] as a gzipped tar file.''
 +
 
 +
;[[/Programming Tutorial KDE 3|Programming Tutorial for KDE 3]]
 +
 
 +
;[[/Programming Tutorial KDE 4|Programming Tutorial for KDE 4]]
 +
:''You are interested in writing applications for KDE 4? Here you get at tutorial which leads you from the beginners stuff to the advanced techniques.''
 +
 
 +
;[[/Debugging|Debug your application]]
 +
 
 +
== Components and Plugins ==
 +
 
 +
;[http://www-106.ibm.com/developerworks/linux/edu/l-dw-linuxkp1-i.html Creating KParts Component]
 +
:''Tutorial on IBM DeveloperWorks, by [mailto:[email protected] David Faure] shows developers how to create KParts components, under KDE 2 and KDE 3.''
 +
 
 +
;[http://phil.freehackers.org/kde/kpart-techno/kpart-techno.html KParts demonstration]
 +
:''Tutorial by [mailto:pfremy at kde dot org Philippe Fremy] demonstrating the use of KParts in KDE applications, including KOffice. Applies mostly to KDE 2.x.''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/xmlui/preface.html KDE User Interface Tutorial (XML GUI)]
 +
:''Tutorial by KDE developer [mailto:[email protected] Kurt Granroth] showing how to convert an existing KDE application to use the new XML based user interface builder.''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/rich/kde-tutorial.html GUI building with KDE]
 +
:''An introduction to creating a basic KDE application. This tutorial is now somewhat out of date, there are better ways of doing things than the ones described here.''
 +
:(Somewhat dated, and the XML GUI Tutorial above is a better read now.)
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/components/index.html Embedded Components Tutorial]
 +
:''Tutorial by KDE developer [mailto:[email protected] Kurt Granroth] showing how to convert an existing KDE application into a component suitable for embedding in [http://www.konqueror.org Konqueror].''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/dot/writing-plugins.html Writing Plugins For KDE Applications]
 +
:''This tutorial aims to demonstrate how easy it is to write plugins for KDE 2 using KParts.''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html Developing a Plugin Structure for a KDE Applications]
 +
:''This tutorial will take you through all the steps needed to write a plugin structure, plus plugins for your KDE application.''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/kfile-plugin/t1.html Providing file meta-data support with KFile plugins]
 +
:''Tutorial by [mailto:[email protected] Brad Hards] that describes how to write a meta-data plugin for your favourite file format. It is presented as an example based tutorial.''
 +
 
 +
== DCOP and other automation Tutorials ==
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/dot/dcopiface/dcop-interface.html Creating a DCOP Interface]
 +
:''This tutorial shows you how to create a DCOP interface to a KDE application.''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/automation/index.html KDE Automation writeup]
 +
:''Document by [mailto:[email protected] Olaf Zanger] showing an overview of the scripting capabilities in KDE 2.x. Includes usage of "dcop", "kdcop", scripting languages, xmlrpc,  and a FAQ.''
 +
 
 +
;[http://www-106.ibm.com/developerworks/linux/library/l-dcop/index.html?ca=dgr-kdeml01KDEDCOP Connect KDE applications using DCOP]
 +
:''IBM DeveloperWorks tutorial, shows how to use kdcop and dcop with several examples such as instantly messaging a contact in kopete when he comes online, and also how to create a simple DCOP-aware application.''
 +
 
 +
== Other tutorials ==
 +
 
 +
;[http://www.heise.de/ct/english/01/05/242/ KIO Tutorial] ([http://www.heise.de/ct/01/05/242/default.shtml German version])
 +
:''Tutorial by KDE developers [mailto:[email protected] Carsten Pfeiffer] and [mailto:[email protected] Stephan Kulow] for the [http://www.heise.de/ct/ c't Magazine], giving an introduction into the KDE IO Architecture and an example KIO Slave.''
 +
 
 +
;[http://developer.kde.org/documentation/design/kde/ioslaves/index.html Using IOSlaves]
 +
:''IOSlaves are the subprocesses KDE uses to fetch remote files without blocking the user interface. This document discusses how they work and how to use them.''
 +
:(Somewhat dated, but might still be useful).
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/kdeeduplot/kdeeduplot_tutorial.tar.bz2 Using and extending the KDE EDU Plot widget (docbook archive)]
 +
:''This tutorial introduces Jason Harris' KPlotWidget that is part of the KDE EDU package. Contains information about defining your own widget in QT / KDevelop designer and about subclassing widgets and overriding member functions to extend functionality.''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/dot/panel-applets.html Extending the KDE Panel]
 +
:''This tutorial teaches you how to implement a simple panel applet using the panel applet API.  It is a suitable task for an introduction to KDE programming.''
 +
 
 +
;[http://www.xs4all.nl/~bsarempt/python/tutorial.html KDE-Python tutorial]
 +
:''A python version of Daniel's KDE tutorial by Boudewijn Rempt.''
 +
 
 +
;[http://developer.kde.org/language-bindings/ruby/kde3tutorial/index.html KDE Ruby Korundum tutorial]
 +
:''A ruby version of Antonio Larrosa Jiménez's KDE tutorial by Richard Dale. See the [http://developer.kde.org/language-bindings/ruby/index.html Ruby Developers Corner] for Qt tutorials and other info.''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/dot/servicemenus.html Creating Konqueror Service Menus]
 +
:''This tutorial shows you how to create mimetype-specific actions in Konqueror's context menu (aka "servicemenus")''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/kconfigxt/kconfigxt.html Using KConfig XT]
 +
:''Tutorial on how to efficiently use the KConfig XT framework (available in KDE 3.2).''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/kiosk/index.html Understanding KDE Kiosk mode]
 +
:''Tutorial on how KDE's kiosk mode is implemented and how you can get started working with it.''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/kdialog/t1.html Shell Scripting with KDE dialogs] ([http://developer.kde.org/documentation/tutorials/kdialog-german/t1.html German Version])
 +
:''Tutorial by [mailto:[email protected] Brad Hards] that describes how to use KDE dialogs in shell scripts with kdialog. It is presented as an example based tutorial.''
 +
 
 +
;[http://www.usermode.org/docs/kwintheme.html KWin decoration styles]
 +
:''Tutorial on creating decoration plugins for the KWin window manager (KDE 3.2 and later).''
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/knewstuffsecure/index.html KNewStuffSecure: a secure way to share resources]
 +
:''Tutorial showing how to share resources in a secured way (KDE 3.4 and later).''
 +
 
 +
 
 +
;[http://developer.kde.org/documentation/tutorials/writingunittests/writingunittests.html Writing Unittests for Qt4 and KDE4 with QTestLib]
 +
:''Tutorial by [mailto:[email protected] Brad Hards] that describes how to write unit tests using the QTestLib framework. It is presented as an example based tutorial, and is still under development.''

Revision as of 20:40, 9 November 2006

Tutorials are the fastest way of finding out what KDE will do for you, and how to do it. Here is a list of currently available tutorials.

Getting started

Using Subversion with KDE
A quick KDE-specific introduction how to work with KDE's version control system
Coding with Qt and KDE
Two tutorials introducing KDE and Qt brought to you by KDE-Women.
KDE 3.0 Tutorial
An excellent tutorial by KDE developer Antonio Larrosa Jiménez leading you from nothing to a fairly full featured web browser. Highly recommended for KDE 3.0 developers.
A KDE tutorial, KHello
A KDE 2 programming tutorial by Daniel Marjamäki. This tutorial introduces the KDE APIs using a graphical version of the world famous 'hello world' program. This document is also available in single download as a gzipped tar file.
Programming Tutorial for KDE 3
Programming Tutorial for KDE 4
You are interested in writing applications for KDE 4? Here you get at tutorial which leads you from the beginners stuff to the advanced techniques.
Debug your application

Components and Plugins

Creating KParts Component
Tutorial on IBM DeveloperWorks, by David Faure shows developers how to create KParts components, under KDE 2 and KDE 3.
KParts demonstration
Tutorial by at kde dot org Philippe Fremy demonstrating the use of KParts in KDE applications, including KOffice. Applies mostly to KDE 2.x.
KDE User Interface Tutorial (XML GUI)
Tutorial by KDE developer Kurt Granroth showing how to convert an existing KDE application to use the new XML based user interface builder.
GUI building with KDE
An introduction to creating a basic KDE application. This tutorial is now somewhat out of date, there are better ways of doing things than the ones described here.
(Somewhat dated, and the XML GUI Tutorial above is a better read now.)
Embedded Components Tutorial
Tutorial by KDE developer Kurt Granroth showing how to convert an existing KDE application into a component suitable for embedding in Konqueror.
Writing Plugins For KDE Applications
This tutorial aims to demonstrate how easy it is to write plugins for KDE 2 using KParts.
Developing a Plugin Structure for a KDE Applications
This tutorial will take you through all the steps needed to write a plugin structure, plus plugins for your KDE application.
Providing file meta-data support with KFile plugins
Tutorial by Brad Hards that describes how to write a meta-data plugin for your favourite file format. It is presented as an example based tutorial.

DCOP and other automation Tutorials

Creating a DCOP Interface
This tutorial shows you how to create a DCOP interface to a KDE application.
KDE Automation writeup
Document by Olaf Zanger showing an overview of the scripting capabilities in KDE 2.x. Includes usage of "dcop", "kdcop", scripting languages, xmlrpc, and a FAQ.
Connect KDE applications using DCOP
IBM DeveloperWorks tutorial, shows how to use kdcop and dcop with several examples such as instantly messaging a contact in kopete when he comes online, and also how to create a simple DCOP-aware application.

Other tutorials

KIO Tutorial (German version)
Tutorial by KDE developers Carsten Pfeiffer and Stephan Kulow for the c't Magazine, giving an introduction into the KDE IO Architecture and an example KIO Slave.
Using IOSlaves
IOSlaves are the subprocesses KDE uses to fetch remote files without blocking the user interface. This document discusses how they work and how to use them.
(Somewhat dated, but might still be useful).
Using and extending the KDE EDU Plot widget (docbook archive)
This tutorial introduces Jason Harris' KPlotWidget that is part of the KDE EDU package. Contains information about defining your own widget in QT / KDevelop designer and about subclassing widgets and overriding member functions to extend functionality.
Extending the KDE Panel
This tutorial teaches you how to implement a simple panel applet using the panel applet API. It is a suitable task for an introduction to KDE programming.
KDE-Python tutorial
A python version of Daniel's KDE tutorial by Boudewijn Rempt.
KDE Ruby Korundum tutorial
A ruby version of Antonio Larrosa Jiménez's KDE tutorial by Richard Dale. See the Ruby Developers Corner for Qt tutorials and other info.
Creating Konqueror Service Menus
This tutorial shows you how to create mimetype-specific actions in Konqueror's context menu (aka "servicemenus")
Using KConfig XT
Tutorial on how to efficiently use the KConfig XT framework (available in KDE 3.2).
Understanding KDE Kiosk mode
Tutorial on how KDE's kiosk mode is implemented and how you can get started working with it.
Shell Scripting with KDE dialogs (German Version)
Tutorial by Brad Hards that describes how to use KDE dialogs in shell scripts with kdialog. It is presented as an example based tutorial.
KWin decoration styles
Tutorial on creating decoration plugins for the KWin window manager (KDE 3.2 and later).
KNewStuffSecure: a secure way to share resources
Tutorial showing how to share resources in a secured way (KDE 3.4 and later).


Writing Unittests for Qt4 and KDE4 with QTestLib
Tutorial by Brad Hards that describes how to write unit tests using the QTestLib framework. It is presented as an example based tutorial, and is still under development.

Content is available under Creative Commons License SA 4.0 unless otherwise noted.