Development/Tutorials: Difference between revisions

From KDE TechBase
(Added <translate> tags and Special:myLanguage for links.)
Line 1: Line 1:
<languages />
<translate>
{{Template:I18n/Language Navigation Bar|Development/Tutorials}}
{{Template:I18n/Language Navigation Bar|Development/Tutorials}}


Line 5: Line 7:
== Basics of KDE 4 Programming ==
== Basics of KDE 4 Programming ==
Are you interested in writing applications with KDE 4? This tutorial series is aimed at those completely new to KDE programming.
Are you interested in writing applications with KDE 4? This tutorial series is aimed at those completely new to KDE programming.
;[[Development/Tutorials/First program|Hello World]]
;[[Special:myLanguage/Development/Tutorials/First program|Hello World]]
:''An introduction to the very basics of KDE4 programming''
:''An introduction to the very basics of KDE4 programming''


;[[Development/Tutorials/Using KXmlGuiWindow|Creating the Main Window]]
;[[Special:myLanguage/Development/Tutorials/Using KXmlGuiWindow|Creating the Main Window]]
:''This tutorial shows you the magic of an application's most important thing: The main window.''
:''This tutorial shows you the magic of an application's most important thing: The main window.''


;[[Development/Tutorials/Using KActions|Using KActions]]
;[[Special:myLanguage/Development/Tutorials/Using KActions|Using KActions]]
:''How to add actions to the menus and toolbars.'' Based on the MainWindow tutorial.
:''How to add actions to the menus and toolbars.'' Based on the MainWindow tutorial.


;[[Development/Tutorials/Saving and loading|Saving and Loading]]
;[[Special:myLanguage/Development/Tutorials/Saving and loading|Saving and Loading]]
:''Introduces the KIO library while adding loading and saving support to our application.''
:''Introduces the KIO library while adding loading and saving support to our application.''


;[[Development/Tutorials/SqLite|Using SqLite databases and QtSql]]
;[[Special:myLanguage/Development/Tutorials/SqLite|Using SqLite databases and QtSql]]
: integrated databases without the need for a database server
: integrated databases without the need for a database server


;[[Development/Tutorials/KCmdLineArgs|Command line arguments]]
;[[Special:myLanguage/Development/Tutorials/KCmdLineArgs|Command line arguments]]
:''Adds the ability to specify which file to open from the command line to our text editor.''
:''Adds the ability to specify which file to open from the command line to our text editor.''


;[[Development/Tutorials/CMake|Introduction to CMake]]
;[[Special:myLanguage/Development/Tutorials/CMake|Introduction to CMake]]
:''How to use the CMake build system used by KDE4.''
:''How to use the CMake build system used by KDE4.''


;[[Development/Tutorials/Common Programming Mistakes|Common Programming Mistakes]]
;[[Special:myLanguage/Development/Tutorials/Common Programming Mistakes|Common Programming Mistakes]]
:''Various common mistakes made while developing Qt and KDE applications and how to avoid them.''
:''Various common mistakes made while developing Qt and KDE applications and how to avoid them.''


;[[Development/Tutorials/Debugging Linker Errors|Debugging Linker Errors]]
;[[Special:myLanguage/Development/Tutorials/Debugging Linker Errors|Debugging Linker Errors]]
:''How to understand and debug errors from the linker, at compile time.''
:''How to understand and debug errors from the linker, at compile time.''


;[[Development/Tutorials/Using Qt Creator|Using Qt Creator to develop your KDE program]]
;[[Special:myLanguage/Development/Tutorials/Using Qt Creator|Using Qt Creator to develop your KDE program]]
:''How to use Qt Creator as an [http://en.wikipedia.org/wiki/Integrated_development_environment IDE] to develop KDE programs''
:''How to use Qt Creator as an [http://en.wikipedia.org/wiki/Integrated_development_environment IDE] to develop KDE programs''


;[[Development/Tutorials/Creating Libraries|Creating Libraries to share code]]
;[[Special:myLanguage/Development/Tutorials/Creating Libraries|Creating Libraries to share code]]
:''How to add the library to the buildsystem and how to prepare the source code.''
:''How to add the library to the buildsystem and how to prepare the source code.''


;[[Development/Tutorials/Session_Management|Session Management]]
;[[Special:myLanguage/Development/Tutorials/Session_Management|Session Management]]
:''Make your application aware of X sessions''
:''Make your application aware of X sessions''


;[[Development/Tutorial/Icons|Icons]]
;[[Special:myLanguage/Development/Tutorial/Icons|Icons]]
:''Deliver your application with icons that are automatically installed to the right places''. Based on the [[Development/Tutorials/Using_KActions|Kaction Tutorial]].
:''Deliver your application with icons that are automatically installed to the right places''. Based on the [[Development/Tutorials/Using_KActions|Kaction Tutorial]].


;[[Development/Tutorials/Desktop_File|Desktop File]]
;[[Special:myLanguage/Development/Tutorials/Desktop_File|Desktop File]]
:''Let your application show up in the K menu and in application menus''. Based on the Icons Tutorial.
:''Let your application show up in the K menu and in application menus''. Based on the Icons Tutorial.


== Testing And Debugging ==
== Testing And Debugging ==


;[[Development/Tutorials/Debugging|Debugging your application]]
;[[Special:myLanguage/Development/Tutorials/Debugging|Debugging your application]]
:''Tips, tools and techniques to apply when debugging your KDE application''
:''Tips, tools and techniques to apply when debugging your KDE application''


;[[Development/Tutorials/Unittests|Writing Unittests for Qt4 and KDE4 with QTestLib]] ([http://developer.kde.org/documentation/tutorials/writingunittests/writingunittests.html Original link])
;[[Special:myLanguage/Development/Tutorials/Unittests|Writing Unittests for Qt4 and KDE4 with QTestLib]] ([http://developer.kde.org/documentation/tutorials/writingunittests/writingunittests.html Original link])
:''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.''
:''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.''


;[[Development/Tutorials/Code_Checking|Semi-automatic ways to detect code errors]]
;[[Special:myLanguage/Development/Tutorials/Code_Checking|Semi-automatic ways to detect code errors]]
:''Techniques you can use to detect errors in KDE code''
:''Techniques you can use to detect errors in KDE code''


== Managing Configuration Data With KConfig ==
== Managing Configuration Data With KConfig ==
;[[Development/Tutorials/KConfig|Introduction To KConfig]]
;[[Special:myLanguage/Development/Tutorials/KConfig|Introduction To KConfig]]
:''An overview of the KConfig classes and how to use them in your application code''
:''An overview of the KConfig classes and how to use them in your application code''


;[[Development/Tutorials/Using KConfig XT|Using KConfig XT]]
;[[Special:myLanguage/Development/Tutorials/Using KConfig XT|Using KConfig XT]]
:''Tutorial on how to efficiently use the KConfig XT framework.''
:''Tutorial on how to efficiently use the KConfig XT framework.''


;[[Development/Tutorials/Updating KConfig Files|Updating KConfig Files]]
;[[Special:myLanguage/Development/Tutorials/Updating KConfig Files|Updating KConfig Files]]
:''Tutorial on how to write an update script to keep changes in your application's config file format in sync with the user's already existing config file''
:''Tutorial on how to write an update script to keep changes in your application's config file format in sync with the user's already existing config file''


== Services: Applications and Plugins ==
== Services: Applications and Plugins ==
;[[Development/Tutorials/Services/Introduction|Introduction to the Services Framework]]
;[[Special:myLanguage/Development/Tutorials/Services/Introduction|Introduction to the Services Framework]]
:''An overview of the services framework in KDE and what it provides the application developer. Covers the system configuration cache (SyCoCa), the source data files and what the indexed information can be used for.''
:''An overview of the services framework in KDE and what it provides the application developer. Covers the system configuration cache (SyCoCa), the source data files and what the indexed information can be used for.''


;[[Development/Tutorials/Services/Traders|Finding Services Using Trader Queries]]
;[[Special:myLanguage/Development/Tutorials/Services/Traders|Finding Services Using Trader Queries]]
:''How to find services, such as plugins or mimetypes, that are indexed in the SyCoCa using Trader Query Syntax''
:''How to find services, such as plugins or mimetypes, that are indexed in the SyCoCa using Trader Query Syntax''


;[[Development/Tutorials/Services/Plugins|Creating and Loading Plugins Using KService]]
;[[Special:myLanguage/Development/Tutorials/Services/Plugins|Creating and Loading Plugins Using KService]]
:''Learn how to define custom plugin types, find installed plugins (including 3rd party plugins) and load them in an easy and portable fashion using KService.''
:''Learn how to define custom plugin types, find installed plugins (including 3rd party plugins) and load them in an easy and portable fashion using KService.''


== Localization ==
== Localization ==
See also [[Localization|Localization portal]].
See also [[Special:myLanguage/Localization|Localization portal]].


;[[Development/Tutorials/Localization/Unicode|Introduction To Unicode]]
;[[Development/Tutorials/Localization/Unicode|Introduction To Unicode]]
:''An introduction to what Unicode is as well as how to handle Unicode data in KDE applications.''
:''An introduction to what Unicode is as well as how to handle Unicode data in KDE applications.''


; [[Development/Tutorials/Localization/i18n|Writing Applications With Localization In Mind]]
; [[Special:myLanguage/Development/Tutorials/Localization/i18n|Writing Applications With Localization In Mind]]
:''This tutorial covers what localization is, why it's important and how to ensure your application is ready to be localized. A must read for all application developers.''
:''This tutorial covers what localization is, why it's important and how to ensure your application is ready to be localized. A must read for all application developers.''


; [[Development/Tutorials/Localization/i18n Mistakes|Avoiding Common Localization Pitfalls]]
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Mistakes|Avoiding Common Localization Pitfalls]]
:''There are several common mistakes that prevent applications from being properly localized. Find out what they are and how to easily avoid them in this tutorial.''
:''There are several common mistakes that prevent applications from being properly localized. Find out what they are and how to easily avoid them in this tutorial.''


; [[Development/Tutorials/Localization/Building KDE's l10n Module|Building KDE's Localization Module]]
; [[Special:myLanguage/Development/Tutorials/Localization/Building KDE's l10n Module|Building KDE's Localization Module]]
:''Building and installing language support from KDE's localization (l10n) module is a good idea for those working on applications in the main KDE repository. Doing so will allow you to test your application in another language and spot problem areas. Learn how to do just that in this tutorial.''
:''Building and installing language support from KDE's localization (l10n) module is a good idea for those working on applications in the main KDE repository. Doing so will allow you to test your application in another language and spot problem areas. Learn how to do just that in this tutorial.''


; [[Development/Tutorials/Localization/i18n Build Systems|Incorporating i18n Into the Build System]]
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Build Systems|Incorporating i18n Into the Build System]]
:''Once your application is ready to be localized, the next step is to ensure that translation files are built automatically and kept up to date. This tutorial covers the necessary CMakeFiles.txt additions as well the process of distributing the resulting message catalogs with your application.''
:''Once your application is ready to be localized, the next step is to ensure that translation files are built automatically and kept up to date. This tutorial covers the necessary CMakeFiles.txt additions as well the process of distributing the resulting message catalogs with your application.''


; [[Development/Tutorials/Localization/i18n Challenges|Common i18n Challenges and Solutions]]
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Challenges|Common i18n Challenges and Solutions]]
:''This tutorial covers challenges that you may eventually run into such as translating handbooks and other data that exists outside of the source code, merging and handling obsolete .po files, dealing with freezes, coding in languages other than English and creating independent releases of or moving applications between KDE modules.''
:''This tutorial covers challenges that you may eventually run into such as translating handbooks and other data that exists outside of the source code, merging and handling obsolete .po files, dealing with freezes, coding in languages other than English and creating independent releases of or moving applications between KDE modules.''


; [[Development/Tutorials/Localization/i18n_Semantics|Semantic Markup of Messages]]
; [[Special:myLanguage/Development/Tutorials/Localization/i18n_Semantics|Semantic Markup of Messages]]
:''To ensure consistent presentation and more meaningful representations of messages in applications, semantic markup can be applied to messages marked for translation using the KUIT system. This tutorial describes how this system works.''
:''To ensure consistent presentation and more meaningful representations of messages in applications, semantic markup can be applied to messages marked for translation using the KUIT system. This tutorial describes how this system works.''


; [[Development/Tutorials/Localization/i18n Krazy|Automated i18n Code Checking]]
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Krazy|Automated i18n Code Checking]]
:''The Krazy code checker scans KDE's code and reports common i18n mistakes.''
:''The Krazy code checker scans KDE's code and reports common i18n mistakes.''


== Documentation ==
== Documentation ==


;[[Development/Tutorials/API_Documentation|API Documentation]]
;[[Special:myLanguage/Development/Tutorials/API_Documentation|API Documentation]]
:''This tutorial explains how to document your APIs properly.''
:''This tutorial explains how to document your APIs properly.''


;[[Development/Tutorials/Man_Pages|Man Pages]]
;[[Special:myLanguage/Development/Tutorials/Man_Pages|Man Pages]]
:''Writing and Generating Reference Manual Pages.''
:''Writing and Generating Reference Manual Pages.''


;Source Code
;Source Code
: http://gitweb.kde.org
: http://quickgit.kde.org
: http://websvn.kde.org
: http://websvn.kde.org


== Accessibility ==
== Accessibility ==


;[[Development/Tutorials/Accessibility|Accessibility Overview]]
;[[Special:myLanguage/Development/Tutorials/Accessibility|Accessibility Overview]]
:''A list of accessibility tutorials and general information.''
:''A list of accessibility tutorials and general information.''


;[[Development/Tutorials/Accessibility/Checklist|Accessibility Checklist]]
;[[Special:myLanguage/Development/Tutorials/Accessibility/Checklist|Accessibility Checklist]]
:''What to look for in your application to make it accessible for as many people as possible.''
:''What to look for in your application to make it accessible for as many people as possible.''


;[[Development/Tutorials/Accessibility/Screen_Reader_Setup|Screen Reader]]
;[[Special:myLanguage/Development/Tutorials/Accessibility/Screen_Reader_Setup|Screen Reader]]
:''This tutorial will explain some details about using screen readers with KDE applications.''
:''This tutorial will explain some details about using screen readers with KDE applications.''


;[[Development/Tutorials/Text-To-Speech|Text-To-Speech]]
;[[Special:myLanguage/Development/Tutorials/Text-To-Speech|Text-To-Speech]]
:''How to utilize Jovie text-to-speech service in your application.''
:''How to utilize Jovie text-to-speech service in your application.''


Line 134: Line 136:


=== D-Bus ===
=== D-Bus ===
; [[Development/Tutorials/D-Bus/Introduction|Introduction to D-Bus]]
; [[Special:myLanguage/Development/Tutorials/D-Bus/Introduction|Introduction to D-Bus]]
:''A straight-forward introduction to the core concepts in D-Bus from an application developer's perspective, this tutorial covers what D-Bus is and how it can be used by applications.''
:''A straight-forward introduction to the core concepts in D-Bus from an application developer's perspective, this tutorial covers what D-Bus is and how it can be used by applications.''
; [[Development/Tutorials/D-Bus/Accessing Interfaces|Accessing D-Bus Interfaces]]
; [[Special:myLanguage/Development/Tutorials/D-Bus/Accessing Interfaces|Accessing D-Bus Interfaces]]
:''A step-by-step guide to calling D-Bus methods and connecting to D-Bus signals using QtDBus.''
:''A step-by-step guide to calling D-Bus methods and connecting to D-Bus signals using QtDBus.''
; [[Development/Tutorials/D-Bus/Intermediate_D-Bus|Intermediate D-Bus]]
; [[Special:myLanguage/Development/Tutorials/D-Bus/Intermediate_D-Bus|Intermediate D-Bus]]
:''Tips to make use of QtDBus when faced with problematic real-world interfaces.''
:''Tips to make use of QtDBus when faced with problematic real-world interfaces.''
; [[Development/Tutorials/D-Bus/Creating Interfaces|Creating D-Bus Interfaces]]
; [[Special:myLanguage/Development/Tutorials/D-Bus/Creating Interfaces|Creating D-Bus Interfaces]]
:''Learn how to expose functionality in your application by creating and using custom D-Bus interfaces. Covers generating the XML descriptions, instantiating interfaces at run time and setting up the build system with CMake.''
:''Learn how to expose functionality in your application by creating and using custom D-Bus interfaces. Covers generating the XML descriptions, instantiating interfaces at run time and setting up the build system with CMake.''
; [[Development/Tutorials/D-Bus/CustomTypes|Using Custom Types with D-Bus]]: ''Learn how to use your own types in classes exported on D-Bus. Covers marhaling and unmarshaling of objects, the integration of custom types into XML descriptions and registering the custom types with the Qt Meta Object system.''
; [[Special:myLanguage/Development/Tutorials/D-Bus/CustomTypes|Using Custom Types with D-Bus]]: ''Learn how to use your own types in classes exported on D-Bus. Covers marhaling and unmarshaling of objects, the integration of custom types into XML descriptions and registering the custom types with the Qt Meta Object system.''
; [[Development/Tutorials/D-Bus/Autostart Services|D-Bus Autostart Services]]
; [[Special:myLanguage/Development/Tutorials/D-Bus/Autostart Services|D-Bus Autostart Services]]
:''Turn your application into a D-Bus autostart service with this tutorial. This D-Bus feature, also known as "D-Bus service activation", will ensure that even when your application isn't running that D-Bus calls made to it will work by relying on the D-Bus daemon itself to start your app if and when needed.''
:''Turn your application into a D-Bus autostart service with this tutorial. This D-Bus feature, also known as "D-Bus service activation", will ensure that even when your application isn't running that D-Bus calls made to it will work by relying on the D-Bus daemon itself to start your app if and when needed.''
; [[Development/Tutorials/Porting_to_D-Bus|Porting from DCOP to D-Bus]]
; [[Special:myLanguage/Development/Tutorials/Porting_to_D-Bus|Porting from DCOP to D-Bus]]
: ''Port your applications from DCOP to D-Bus with this handy guide.''
: ''Port your applications from DCOP to D-Bus with this handy guide.''


=== Konqueror ===
=== Konqueror ===
; [[Development/Tutorials/Creating Konqueror Service Menus|Creating Konqueror Service Menus]]
; [[Special:myLanguage/Development/Tutorials/Creating Konqueror Service Menus|Creating Konqueror Service Menus]]
:''This tutorial shows you how to create mimetype-specific actions in Konqueror's context menu (aka "servicemenus").''
:''This tutorial shows you how to create mimetype-specific actions in Konqueror's context menu (aka "servicemenus").''


=== Kross ===
=== Kross ===
; [[Development/Tutorials/Kross/Introduction|Introduction to Kross]]
; [[Special:myLanguage/Development/Tutorials/Kross/Introduction|Introduction to Kross]]
:''An introduction to the Kross Scripting Framework.''
:''An introduction to the Kross Scripting Framework.''


; [[Development/Tutorials/Kross/Hello_World|Hello World]]
; [[Special:myLanguage/Development/Tutorials/Kross/Hello_World|Hello World]]
:''A first application with working kross code.''
:''A first application with working kross code.''


; [[Development/Tutorials/Kross/Call_Functions_in_Kross|Calling Functions in Kross]]
; [[Special:myLanguage/Development/Tutorials/Kross/Call_Functions_in_Kross|Calling Functions in Kross]]
:''Simple demonstration of calling scripting functions''
:''Simple demonstration of calling scripting functions''


; [[Development/Tutorials/Kross/Connecting_Signals_and_slots_in_Kross|Connecting Signals and Slots in Kross]]
; [[Special:myLanguage/Development/Tutorials/Kross/Connecting_Signals_and_slots_in_Kross|Connecting Signals and Slots in Kross]]
:''Simple demonstration of connecting object signals with script slots''
:''Simple demonstration of connecting object signals with script slots''


; [[Development/Tutorials/Kross/Scripts-as-Plugins|Scripts as Plugins with Kross]]
; [[Special:myLanguage/Development/Tutorials/Kross/Scripts-as-Plugins|Scripts as Plugins with Kross]]
:''This tutorial provides a step-by-step introduction how to integrate scripts as plugins into a KDE application.''
:''This tutorial provides a step-by-step introduction how to integrate scripts as plugins into a KDE application.''


; [[Development/Tutorials/Kross/Script-Actions|Placing script actions in your application menus ]]
; [[Special:myLanguage/Development/Tutorials/Kross/Script-Actions|Placing script actions in your application menus ]]
:''Simple demonstration on how to extend you application menus to execute script files.''
:''Simple demonstration on how to extend you application menus to execute script files.''


; [[Development/Tutorials/Kross/ActionCollections|How to use an ActionCollection ]]
; [[Special:myLanguage/Development/Tutorials/Kross/ActionCollections|How to use an ActionCollection ]]
:''A small Tutorial on How to use Kross::ActionCollections.''
:''A small Tutorial on How to use Kross::ActionCollections.''
{{:KOffice/Plugin Tutorials}}
{{:KOffice/Plugin Tutorials}}


=== SuperKaramba ===
=== SuperKaramba ===
; [[Development/Tutorials/SuperKaramba|SuperKaramba Tutorial]]
; [[Special:myLanguage/Development/Tutorials/SuperKaramba|SuperKaramba Tutorial]]
:''This tutorial provides an overview of SuperKaramba, theme files and scripting with Python, Ruby and JavaScript.''
:''This tutorial provides an overview of SuperKaramba, theme files and scripting with Python, Ruby and JavaScript.''


=== System Activity ===
=== System Activity ===


: [[Development/Tutorials/SystemActivity/Scripting|Writing script actions for the process's context menu]]
: [[Special:myLanguage/Development/Tutorials/SystemActivity/Scripting|Writing script actions for the process's context menu]]
:''This tutorial shows how to add a context menu action to show custom information about a process.
:''This tutorial shows how to add a context menu action to show custom information about a process.


=== KWin ===
=== KWin ===
: [[Development/Tutorials/KWin/Scripting|KWin Scripting Tutorial]]
: [[Special:myLanguage/Development/Tutorials/KWin/Scripting|KWin Scripting Tutorial]]
:''This tutorial shows how to write a useful script for KWin.
:''This tutorial shows how to write a useful script for KWin.


== Plugins and KParts ==
== Plugins and KParts ==


; [[Development/Tutorials/Using KParts|Using KParts]]:''A kPart is a plugin that you can just load into your application. For example, it is easy to integrate an editor (the katePart) or a console (the konsolePart) into your application's window.''
; [[Special:myLanguage/Development/Tutorials/Using KParts|Using KParts]]:''A kPart is a plugin that you can just load into your application. For example, it is easy to integrate an editor (the katePart) or a console (the konsolePart) into your application's window.''


; [[Development/Tutorials/Writing kontact plugins|Writing kontact plugins]]:''Kontact plugins are KParts. This tutorial describes how you can write one.''
; [[Special:myLanguage/Development/Tutorials/Writing kontact plugins|Writing kontact plugins]]:''Kontact plugins are KParts. This tutorial describes how you can write one.''


; [[Development/Tutorials/Writing Qt Designer Plugins|Writing Qt Designer Plugins]]:''Add your widgets to Qt Designer and thus make them usable in UI files.''
; [[Special:myLanguage/Development/Tutorials/Writing Qt Designer Plugins|Writing Qt Designer Plugins]]:''Add your widgets to Qt Designer and thus make them usable in UI files.''


== Search and Metadata ==
== Search and Metadata ==
Line 200: Line 202:
=== Strigi ===
=== Strigi ===


; [[Development/Tutorials/Writing file analyzers|Writing file analyzers]]
; [[Special:myLanguage/Development/Tutorials/Writing file analyzers|Writing file analyzers]]
:''File analyzers extract data from files to display in the file dialogs and file managers. The data gathered this way is also used to search for files. KDE4 allows the use of multiple analyzers per file type. This tutorial describes how you can write new analyzers.''
:''File analyzers extract data from files to display in the file dialogs and file managers. The data gathered this way is also used to search for files. KDE4 allows the use of multiple analyzers per file type. This tutorial describes how you can write new analyzers.''


=== [http://nepomuk.kde.org Nepomuk] ===
=== [http://nepomuk.kde.org Nepomuk] ===


See [[Development/Tutorials/Metadata/Nepomuk|Nepomuk tutorials]].
See [[Special:myLanguage/Development/Tutorials/Metadata/Nepomuk|Nepomuk tutorials]].




== Hardware Awareness (Solid) ==
== Hardware Awareness (Solid) ==


;[[Development/Tutorials/Solid/Introduction|Introduction to Solid]]
;[[Special:myLanguage/Development/Tutorials/Solid/Introduction|Introduction to Solid]]
:''An introduction to the Solid effort in general and it library in particular.''
:''An introduction to the Solid effort in general and it library in particular.''


;[[Development/Tutorials/Solid/Device_Discovery|Listing Devices]]
;[[Special:myLanguage/Development/Tutorials/Solid/Device_Discovery|Listing Devices]]
:''How to use the Solid core library to discover the hardware and interact with the system.''
:''How to use the Solid core library to discover the hardware and interact with the system.''


;[[Development/Tutorials/Solid/Network_Management|Accessing Network Information]]
;[[Special:myLanguage/Development/Tutorials/Solid/Network_Management|Accessing Network Information]]
:''How to use the Solid system to get information about the network''
:''How to use the Solid system to get information about the network''


;[[Development/Tutorials/Solid/Device_Actions|Creating a Device Action]]
;[[Special:myLanguage/Development/Tutorials/Solid/Device_Actions|Creating a Device Action]]
:''When your application is interested in registering actions with the system for removable hardware''
:''When your application is interested in registering actions with the system for removable hardware''


== Authorization and Privilege escalation (KAuth) ==
== Authorization and Privilege escalation (KAuth) ==
; [[Development/Tutorials/KAuth/KAuth_Basics|KAuth Basics]]
; [[Special:myLanguage/Development/Tutorials/KAuth/KAuth_Basics|KAuth Basics]]
:''An overview of concepts and basic knowledge required to understand and use KAuth effectively''
:''An overview of concepts and basic knowledge required to understand and use KAuth effectively''
; [[Development/Tutorials/KAuth/KAuth_Actions|Using KAuth actions in your application]]
; [[Special:myLanguage/Development/Tutorials/KAuth/KAuth_Actions|Using KAuth actions in your application]]
:''How to execute KAuth actions in your application, and how to integrate them tightly into your UI''
:''How to execute KAuth actions in your application, and how to integrate them tightly into your UI''
; [[Development/Tutorials/KAuth/Helper_HowTo|Creating a KAuth helper to perform a privileged action]]
; [[Special:myLanguage/Development/Tutorials/KAuth/Helper_HowTo|Creating a KAuth helper to perform a privileged action]]
:''You will learn how to use KAuth's helpers and escalation facilities, and how to seamlessly make a privileged and non privileged portion of your application interact''
:''You will learn how to use KAuth's helpers and escalation facilities, and how to seamlessly make a privileged and non privileged portion of your application interact''
; [[Development/Tutorials/KAuth/KCM_HowTo|Creating a KCM requiring authorization upon saving]]
; [[Special:myLanguage/Development/Tutorials/KAuth/KCM_HowTo|Creating a KCM requiring authorization upon saving]]
:''Learn how to use the high level KCModule API to create KCModules handling authorization, and its UI integration, on their own''
:''Learn how to use the high level KCModule API to create KCModules handling authorization, and its UI integration, on their own''


== Multimedia (Phonon) ==
== Multimedia (Phonon) ==


;[[Development/Tutorials/Phonon/Introduction|Phonon]]
;[[Special:myLanguage/Development/Tutorials/Phonon/Introduction|Phonon]]
:''How to start with the multimedia API''
:''How to start with the multimedia API''


Line 240: Line 242:
::''This article gives you a quick brief of how you can use checkout, compile Phonon and its GStreamer backend on GNU/Linux with just Qt 4.3.x. Towards the end, the article also describes how a developer can make use of Phonon to create simple audio and video players. You can read the article [http://www.vcreatelogic.com/oss/docs/CompilingPhononOnLinux.pdf here]. You can download the editable OpenDocumentText file from [http://www.prashanthudupa.com/phonon/CompilingPhononOnLinux.odt here].''
::''This article gives you a quick brief of how you can use checkout, compile Phonon and its GStreamer backend on GNU/Linux with just Qt 4.3.x. Towards the end, the article also describes how a developer can make use of Phonon to create simple audio and video players. You can read the article [http://www.vcreatelogic.com/oss/docs/CompilingPhononOnLinux.pdf here]. You can download the editable OpenDocumentText file from [http://www.prashanthudupa.com/phonon/CompilingPhononOnLinux.odt here].''


;[[Development/Tutorials/Phonon/Backends|Writing Backends]]
;[[Special:myLanguage/Development/Tutorials/Phonon/Backends|Writing Backends]]
:''How to start creating a new backend for the multimedia API''
:''How to start creating a new backend for the multimedia API''


Line 248: Line 250:
== Plasma ==
== Plasma ==


See [[Development/Tutorials/Plasma|Plasma tutorials]].
See [[Special:myLanguage/Development/Tutorials/Plasma|Plasma tutorials]].




Line 254: Line 256:
== Personal Information Management (Akonadi) ==
== Personal Information Management (Akonadi) ==


;[[Development/Tutorials/Akonadi/Application|Using Akonadi in Applications]]
;[[Special:myLanguage/Development/Tutorials/Akonadi/Application|Using Akonadi in Applications]]
:''Displaying and modifying data provided by Akonadi''
:''Displaying and modifying data provided by Akonadi''


;[[Development/Tutorials/Akonadi/Resources|Developing Akonadi Resources]]
;[[Special:myLanguage/Development/Tutorials/Akonadi/Resources|Developing Akonadi Resources]]
:''Akonadi Resources are agent programs which transport PIM data between Akonadi and a backend (files, servers, etc)''
:''Akonadi Resources are agent programs which transport PIM data between Akonadi and a backend (files, servers, etc)''


;[[Development/Tutorials/Akonadi/SerializerPlugin|Using custom data types with Akonadi]]
;[[Special:myLanguage/Development/Tutorials/Akonadi/SerializerPlugin|Using custom data types with Akonadi]]
:''Akonadi can handle arbitrary data as item payloads through the use of a plugin based serialization framework''
:''Akonadi can handle arbitrary data as item payloads through the use of a plugin based serialization framework''


;[[Development/AkonadiPorting|Porting Applications which use KResource API]]
;[[Special:myLanguage/Development/AkonadiPorting|Porting Applications which use KResource API]]
:''Applications using KDE's now deprecated KResource APIs, e.g. KABC or KCal, need to be ported to use their Akonadi equivalents''
:''Applications using KDE's now deprecated KResource APIs, e.g. KABC or KCal, need to be ported to use their Akonadi equivalents''


== Kate / Kwrite ==
== Kate / Kwrite ==


;[[Development/Tutorials/Kate/KTextEditor Plugins|Getting started with KTextEditor plugins]]
;[[Special:myLanguage/Development/Tutorials/Kate/KTextEditor Plugins|Getting started with KTextEditor plugins]]
:''Creating your first KTextEditor plugin''
:''Creating your first KTextEditor plugin''


;[[Development/Tutorials/Kate/KTextEditor_Plugins_Advanced|Developing a plugin with configuration dialog]]
;[[Special:myLanguage/Development/Tutorials/Kate/KTextEditor_Plugins_Advanced|Developing a plugin with configuration dialog]]
:''Adding a configuration dialog to the Time & Date example''
:''Adding a configuration dialog to the Time & Date example''


;[[Development/Tutorials/Kate/KTextEditor_Example|A small Editor]]
;[[Special:myLanguage/Development/Tutorials/Kate/KTextEditor_Example|A small Editor]]
:''Create a small application using KTextEditor''
:''Create a small application using KTextEditor''


== KDevelop ==
== KDevelop ==


;[[Development/KDevelop-PG-Qt_Introduction|KDevelop-PG-Qt Introduction]]
;[[Special:myLanguage/Development/KDevelop-PG-Qt_Introduction|KDevelop-PG-Qt Introduction]]
:''Information on the KDevelop parser generator, useful for language plugins.''
:''Information on the KDevelop parser generator, useful for language plugins.''


Line 286: Line 288:
KDE mostly uses the [http://doc.qt.nokia.com/latest/printing.html Qt Printing infrastructure].
KDE mostly uses the [http://doc.qt.nokia.com/latest/printing.html Qt Printing infrastructure].


;[[Development/Tutorials/Printing Hello World|Hello World]]
;[[Special:myLanguage/Development/Tutorials/Printing Hello World|Hello World]]
:''Introduction to the KDE printing system''
:''Introduction to the KDE printing system''


== kioslaves ==
== kioslaves ==
* [[Development/Tutorials/KIO Slaves/Using KIO Slaves in your Program|Using kioslaves in your Program]]
* [[Special:myLanguage/Development/Tutorials/KIO Slaves/Using KIO Slaves in your Program|Using kioslaves in your Program]]
* [[Development/Tutorials/KIO Slaves/Hello World|Creating a Hello-World kioslave]]
* [[Special:myLanguage/Development/Tutorials/KIO Slaves/Hello World|Creating a Hello-World kioslave]]


== Collaboration ==
== Collaboration ==
Line 297: Line 299:
=== Open Collaboration Services (libattica) ===
=== Open Collaboration Services (libattica) ===


;[[Development/Tutorials/Collaboration/Attica/Introduction|Introduction to Attica]]
;[[Special:myLanguage/Development/Tutorials/Collaboration/Attica/Introduction|Introduction to Attica]]
:''In this tutorial a simple widget showing information about a Person on the server is created.''
:''In this tutorial a simple widget showing information about a Person on the server is created.''


=== Get Hot New Stuff  ===
=== Get Hot New Stuff  ===


;[[Development/Tutorials/Collaboration/HotNewStuff/Introduction|Get Hot New Stuff 3 - Download]]  
;[[Special:myLanguage/Development/Tutorials/Collaboration/HotNewStuff/Introduction|Get Hot New Stuff 3 - Download]]  
:''How to use KHotNewStuff3 in your application.''<br>
:''How to use KHotNewStuff3 in your application.''<br>


;[[Development/Tutorials/Collaboration/HotNewStuff/Updates|Get Hot New Stuff 3 - Checking for Updates]]  
;[[Special:myLanguage/Development/Tutorials/Collaboration/HotNewStuff/Updates|Get Hot New Stuff 3 - Checking for Updates]]  
:''How to check if updates for installed stuff are available without showing the dialog/widget.''<br>
:''How to check if updates for installed stuff are available without showing the dialog/widget.''<br>


;[[Development/Tutorials/Collaboration/HotNewStuff/Upload|Get Hot New Stuff 3 - Upload]]  
;[[Special:myLanguage/Development/Tutorials/Collaboration/HotNewStuff/Upload|Get Hot New Stuff 3 - Upload]]  
:''How to add an upload dialog to your application.''<br>
:''How to add an upload dialog to your application.''<br>


Old links for KNS2 and KNS1 content:<br>
Old links for KNS2 and KNS1 content:<br>


;[[Development/Tutorials/K Hot New Stuff2|Introduction to Get Hot New Stuff 2]]  
;[[Special:myLanguage/Development/Tutorials/K Hot New Stuff2|Introduction to Get Hot New Stuff 2]]  
:''A short tutorial about how to use KHotNewStuff2 in your application. Deprecated, use version 3''  
:''A short tutorial about how to use KHotNewStuff2 in your application. Deprecated, use version 3''  
;[[Development/Tutorials/Introduction to Get Hot New Stuff|Introduction to Get Hot New Stuff]]  
;[[Special:myLanguage/Development/Tutorials/Introduction to Get Hot New Stuff|Introduction to Get Hot New Stuff]]  
:''An introduction to the developer-friendly network update system that allows KDE applications to fetch new application data at runtime in a user friendly manner.''
:''An introduction to the developer-friendly network update system that allows KDE applications to fetch new application data at runtime in a user friendly manner.''


;[[Development/Tutorials/KNewStuffSecure|KNewStuff Secure]] ([http://developer.kde.org/documentation/tutorials/knewstuffsecure/index.html Original Link])  
;[[Special:myLanguage/Development/Tutorials/KNewStuffSecure|KNewStuff Secure]] ([http://developer.kde.org/documentation/tutorials/knewstuffsecure/index.html Original Link])  
:''Tutorial showing how to share resources in a secured way (KDE 3.4 and later).'' By András Mantia &lt;[email protected]&gt;.
:''Tutorial showing how to share resources in a secured way (KDE 3.4 and later).'' By András Mantia &lt;[email protected]&gt;.


== Goya ==
== Goya ==
; [[Development/Tutorials/Introduction to Goya usage|Introduction to Goya usage]]
; [[Special:myLanguage/Development/Tutorials/Introduction to Goya usage|Introduction to Goya usage]]
:''An introduction for the Goya subsystem usage, which allows you to easily add widgets to your itemviews and connect their signals to your code, as they were real widgets.''
:''An introduction for the Goya subsystem usage, which allows you to easily add widgets to your itemviews and connect their signals to your code, as they were real widgets.''


; [[Development/Tutorials/Introduction to Goya usage 2|Introduction to Goya usage (part 2)]]
; [[Special:myLanguage/Development/Tutorials/Introduction to Goya usage 2|Introduction to Goya usage (part 2)]]
:''The second part of the tutorial, with a slightly more complex example than the first part.''
:''The second part of the tutorial, with a slightly more complex example than the first part.''


Line 338: Line 340:
:''Another introduction to PyQt''
:''Another introduction to PyQt''


;[[Development/Languages/Python/PyKDE_WebKit_Tutorial|PyKDE WebKit Tutorial]]
;[[Special:myLanguage/Development/Languages/Python/PyKDE_WebKit_Tutorial|PyKDE WebKit Tutorial]]
:''A simple web browser application in PyKDE''
:''A simple web browser application in PyKDE''


;[[Development/Tutorials/Python introduction to signals and slots|101 Introduction to signals and slots]]
;[[Special:myLanguage/Development/Tutorials/Python introduction to signals and slots|101 Introduction to signals and slots]]
:''A simple introduction to Qt's signal and slot architecture.''
:''A simple introduction to Qt's signal and slot architecture.''


;[[Development/Languages/Python/PyKDE_DBus_Tutorial|PyKDE DBus Tutorial]]
;[[Special:myLanguage/Development/Languages/Python/PyKDE_DBus_Tutorial|PyKDE DBus Tutorial]]
:''An introduction to DBus communication using PyKDE''
:''An introduction to DBus communication using PyKDE''


;[[Development/Languages/Python/PyKDE_Knotify_Tutorial|PyKDE KNotify Tutorial]]
;[[Special:myLanguage/Development/Languages/Python/PyKDE_Knotify_Tutorial|PyKDE KNotify Tutorial]]
:''An introduction to Knotify (Notifications and KJobs) using PyKDE''
:''An introduction to Knotify (Notifications and KJobs) using PyKDE''


Line 355: Line 357:
:''A ruby version of Antonio Larrosa Jim&eacute;nez's KDE tutorial by Richard Dale. See the [[Development/Languages/Ruby|Ruby Developers Corner]] for Qt tutorials and other info.''
:''A ruby version of Antonio Larrosa Jim&eacute;nez's KDE tutorial by Richard Dale. See the [[Development/Languages/Ruby|Ruby Developers Corner]] for Qt tutorials and other info.''


;[[Development/Tutorials/Qt4_Ruby_Tutorial|Qt4 Ruby Tutorial]]
;[[Special:myLanguage/Development/Tutorials/Qt4_Ruby_Tutorial|Qt4 Ruby Tutorial]]
:''Nokia's fabulous introductory tutorial to Qt, translated to Ruby.''
:''Nokia's fabulous introductory tutorial to Qt, translated to Ruby.''


;[[Development/Tutorials/Plasma/RubyApplet|Creating a Plasma Widget in Ruby]]
;[[Special:myLanguage/Development/Tutorials/Plasma/RubyApplet|Creating a Plasma Widget in Ruby]]
:''Tutorial that shows how to create your first Plasma Applet using the Ruby language.''
:''Tutorial that shows how to create your first Plasma Applet using the Ruby language.''


;[[Development/Tutorials/Developing_Qt4_Applications_using_Qt_Designer_and_Ruby_on_Kubuntu|Developing Qt4 Applications using Qt Designer and Ruby on Kubuntu]]
;[[Special:myLanguage/Development/Tutorials/Developing_Qt4_Applications_using_Qt_Designer_and_Ruby_on_Kubuntu|Developing Qt4 Applications using Qt Designer and Ruby on Kubuntu]]
:''Tutorial that shows how to design a simple User Interface in Qt Designer and then use the resulting widget in a Qt Ruby application we build from scratch.''
:''Tutorial that shows how to design a simple User Interface in Qt Designer and then use the resulting widget in a Qt Ruby application we build from scratch.''


;[[Development/Languages/Ruby/Ruby-Qt/KDE_Book|Ruby-Qt/KDE Book]]
;[[Special:myLanguage/Development/Languages/Ruby/Ruby-Qt/KDE_Book|Ruby-Qt/KDE Book]]
:''There is also an approach to create an Ruby-Qt/KDE Book under a free license. The content will be created in this wiki.''
:''There is also an approach to create an Ruby-Qt/KDE Book under a free license. The content will be created in this wiki.''


=== Shell ===
=== Shell ===


;[[Development/Tutorials/Shell_Scripting_with_KDE_Dialogs|Shell Scripting with KDE dialogs]] ([http://developer.kde.org/documentation/tutorials/kdialog/t1.html Original Link])  
;[[Special:myLanguage/Development/Tutorials/Shell_Scripting_with_KDE_Dialogs|Shell Scripting with KDE dialogs]] ([http://developer.kde.org/documentation/tutorials/kdialog/t1.html Original Link])  
:''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.''
:''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.''


== Graphics Programming ==
== Graphics Programming ==


;[[Development/Tutorials/Graphics/Performance|QPainter Perfomance]]
;[[Special:myLanguage/Development/Tutorials/Graphics/Performance|QPainter Perfomance]]
:''Hints on avoiding common mistakes leading to poor performance when using QPainter''
:''Hints on avoiding common mistakes leading to poor performance when using QPainter''


== Using the KDE Games Libraries ==
== Using the KDE Games Libraries ==
;[[Development/Tutorials/Games/KStandardGameAction| KStandardGameAction]]
;[[Special:myLanguage/Development/Tutorials/Games/KStandardGameAction| KStandardGameAction]]
:''Using libkdegames to make your game fit the kdegames standard''
:''Using libkdegames to make your game fit the kdegames standard''
;[[Development/Tutorials/Games/Highscores| Highscores]]
;[[Special:myLanguage/Development/Tutorials/Games/Highscores| Highscores]]
:''Implementing a simple highscore table into your game''
:''Implementing a simple highscore table into your game''
;[[Development/Tutorials/Games/Theme Selector| Theme Selector]]
;[[Special:myLanguage/Development/Tutorials/Games/Theme Selector| Theme Selector]]
:''Using the libkdegames theme selection dialog''
:''Using the libkdegames theme selection dialog''
;[[Development/Tutorials/Games/Palapeli Patterns| Palapeli Slicers]]
;[[Special:myLanguage/Development/Tutorials/Games/Palapeli Patterns| Palapeli Slicers]]
:''Creating a slicer plugin for Palapeli''
:''Creating a slicer plugin for Palapeli''


=== KGLEngine ===
=== KGLEngine ===
;[[Development/Tutorials/Games/kglengine/kglengine-simpleBox| installation and your first KGLItem]]
;[[Special:myLanguage/Development/Tutorials/Games/kglengine/kglengine-simpleBox| installation and your first KGLItem]]
:''start your first kglengine application''
:''start your first kglengine application''
;[[Development/Tutorials/Games/KGLEngine2d| kglpong]]
;[[Special:myLanguage/Development/Tutorials/Games/KGLEngine2d| kglpong]]
:''Now use our knowledge to make a pong''
:''Now use our knowledge to make a pong''


== Using the KDE PIM Libraries ==
== Using the KDE PIM Libraries ==
;[[Development/Tutorials/PIM/ical| iCalendar functionality]]
;[[Special:myLanguage/Development/Tutorials/PIM/ical| iCalendar functionality]]
:''Using kcal to manage iCalendar files''
:''Using kcal to manage iCalendar files''


Line 400: Line 402:


=== 2D Plotting (KPlotWidget) ===
=== 2D Plotting (KPlotWidget) ===
;[[Development/Tutorials/KPlotWidget|Using the KDE data-plotting widget]]
;[[Special:myLanguage/Development/Tutorials/KPlotWidget|Using the KDE data-plotting widget]]
:''This tutorial introduces KPlotWidget, which is used for 2-D data plotting.  It includes information on simple usage of the widget (including adding and modifying data sets, and customizing the plot axes and labels), and advanced customization (including extending the widget through sub-classing).''
:''This tutorial introduces KPlotWidget, which is used for 2-D data plotting.  It includes information on simple usage of the widget (including adding and modifying data sets, and customizing the plot axes and labels), and advanced customization (including extending the widget through sub-classing).''


=== Spelling and Grammar Checking (Sonnet) ===
=== Spelling and Grammar Checking (Sonnet) ===
;[[Development/Tutorials/Sonnet/SonnetTutorial|Adding spell-checking or grammar-checking to KDE applications]]
;[[Special:myLanguage/Development/Tutorials/Sonnet/SonnetTutorial|Adding spell-checking or grammar-checking to KDE applications]]
:''This tutorial introduces Sonnet and how one may use it to add language correction to your KDE application. Sonnet's auxiliary features shall be described in a separate tutorial.''
:''This tutorial introduces Sonnet and how one may use it to add language correction to your KDE application. Sonnet's auxiliary features shall be described in a separate tutorial.''


=== Pixmap cache (KPixmapCache) ===
=== Pixmap cache (KPixmapCache) ===
;[[Development/Tutorials/KPixmapCache|Using the KDE pixmap cache]]
;[[Special:myLanguage/Development/Tutorials/KPixmapCache|Using the KDE pixmap cache]]
:''This tutorial shows how to use KPixmapCache to cache e.g. pixmaps generated from SVGs or some data.''
:''This tutorial shows how to use KPixmapCache to cache e.g. pixmaps generated from SVGs or some data.''


=== Using MarbleWidget (Marble) ===
=== Using MarbleWidget (Marble) ===
;[[Development/Tutorials/MarbleWidget|Using MarbleWidget]]
;[[Special:myLanguage/Development/Tutorials/MarbleWidget|Using MarbleWidget]]
:''This short tutorial describes how to use the MarbleWidget in your project''
:''This short tutorial describes how to use the MarbleWidget in your project''


=== Using local SCM for KDE development ===
=== Using local SCM for KDE development ===
;[[Development/Git|Using Git to develop for KDE]]
;[[Special:myLanguage/Development/Git|Using Git to develop for KDE]]
:''Here you find how to use Git to develop for KDE''
:''Here you find how to use Git to develop for KDE''


Line 424: Line 426:


=== Implementing KSysGuard sensors and adding them ===
=== Implementing KSysGuard sensors and adding them ===
;[[Development/Tutorials/Sensors]]
;[[Special:myLanguage/Development/Tutorials/Sensors]]
:''This tutorial shows how to write and KSysGuard sensor and connect it to the systray.''
:''This tutorial shows how to write and KSysGuard sensor and connect it to the systray.''
Runners
Runners


=== Porting an application from KSystemTrayIcon to KStatusNotifierItem ===
=== Porting an application from KSystemTrayIcon to KStatusNotifierItem ===
;[[Development/Tutorials/PortToKStatusNotifierItem]]
;[[Special:myLanguage/Development/Tutorials/PortToKStatusNotifierItem]]
:''This tutorials shows how to port an application using KSystemTrayIcon to KStatusNotifierItem''
:''This tutorials shows how to port an application using KSystemTrayIcon to KStatusNotifierItem''


=== Using the KDE Wallet API for safe storage ===
=== Using the KDE Wallet API for safe storage ===
;[[Development/Tutorials/KWallet]]
;[[Special:myLanguage/Development/Tutorials/KWallet]]
:"Brief introduction to the KWallet API which can be used for storing all kinds of sensitive information."
:"Brief introduction to the KWallet API which can be used for storing all kinds of sensitive information."


===How to edit a wiki with Libmediawiki ===
===How to edit a wiki with Libmediawiki ===
;[[Development/Tutorials/Libmediawiki]]
;[[Special:myLanguage/Development/Tutorials/Libmediawiki]]
:''This tutorial present how to edit a wiki with Libmediawiki.''
:''This tutorial present how to edit a wiki with Libmediawiki.''


== KDE2 and KDE3 Materials ==
== KDE2 and KDE3 Materials ==
;[[Development/Tutorials/KDE4 Porting Guide|Porting Your Application from KDE 3 to KDE 4]]
;[[Special:myLanguage/Development/Tutorials/KDE4 Porting Guide|Porting Your Application from KDE 3 to KDE 4]]
:''These tutorials cover topics related to the migration from KDE 3 to KDE 4.''
:''These tutorials cover topics related to the migration from KDE 3 to KDE 4.''


;[[Development/Tutorials/KDE3|KDE3 Tutorials]]
;[[Special:myLanguage/Development/Tutorials/KDE3|KDE3 Tutorials]]
:''These tutorials cover topics related to KDE3.''
:''These tutorials cover topics related to KDE3.''


;[[Development/Tutorials/KDE2|KDE2 Tutorials]]
;[[Special:myLanguage/Development/Tutorials/KDE2|KDE2 Tutorials]]
:''These tutorials cover topics related to KDE2.''
:''These tutorials cover topics related to KDE2.''


[[Category:KDE4]]
[[Category:KDE4]]
</translate>

Revision as of 09:17, 5 February 2012


Development/Tutorials


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 for KDE4. Material for KDE3 and KDE2 is available on the bottom of this page.

Basics of KDE 4 Programming

Are you interested in writing applications with KDE 4? This tutorial series is aimed at those completely new to KDE programming.

Hello World
An introduction to the very basics of KDE4 programming
Creating the Main Window
This tutorial shows you the magic of an application's most important thing: The main window.
Using KActions
How to add actions to the menus and toolbars. Based on the MainWindow tutorial.
Saving and Loading
Introduces the KIO library while adding loading and saving support to our application.
Using SqLite databases and QtSql
integrated databases without the need for a database server
Command line arguments
Adds the ability to specify which file to open from the command line to our text editor.
Introduction to CMake
How to use the CMake build system used by KDE4.
Common Programming Mistakes
Various common mistakes made while developing Qt and KDE applications and how to avoid them.
Debugging Linker Errors
How to understand and debug errors from the linker, at compile time.
Using Qt Creator to develop your KDE program
How to use Qt Creator as an IDE to develop KDE programs
Creating Libraries to share code
How to add the library to the buildsystem and how to prepare the source code.
Session Management
Make your application aware of X sessions
Icons
Deliver your application with icons that are automatically installed to the right places. Based on the Kaction Tutorial.
Desktop File
Let your application show up in the K menu and in application menus. Based on the Icons Tutorial.

Testing And Debugging

Debugging your application
Tips, tools and techniques to apply when debugging your KDE application
Writing Unittests for Qt4 and KDE4 with QTestLib (Original link)
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.
Semi-automatic ways to detect code errors
Techniques you can use to detect errors in KDE code

Managing Configuration Data With KConfig

Introduction To KConfig
An overview of the KConfig classes and how to use them in your application code
Using KConfig XT
Tutorial on how to efficiently use the KConfig XT framework.
Updating KConfig Files
Tutorial on how to write an update script to keep changes in your application's config file format in sync with the user's already existing config file

Services: Applications and Plugins

Introduction to the Services Framework
An overview of the services framework in KDE and what it provides the application developer. Covers the system configuration cache (SyCoCa), the source data files and what the indexed information can be used for.
Finding Services Using Trader Queries
How to find services, such as plugins or mimetypes, that are indexed in the SyCoCa using Trader Query Syntax
Creating and Loading Plugins Using KService
Learn how to define custom plugin types, find installed plugins (including 3rd party plugins) and load them in an easy and portable fashion using KService.

Localization

See also Localization portal.

Introduction To Unicode
An introduction to what Unicode is as well as how to handle Unicode data in KDE applications.
Writing Applications With Localization In Mind
This tutorial covers what localization is, why it's important and how to ensure your application is ready to be localized. A must read for all application developers.
Avoiding Common Localization Pitfalls
There are several common mistakes that prevent applications from being properly localized. Find out what they are and how to easily avoid them in this tutorial.
Building KDE's Localization Module
Building and installing language support from KDE's localization (l10n) module is a good idea for those working on applications in the main KDE repository. Doing so will allow you to test your application in another language and spot problem areas. Learn how to do just that in this tutorial.
Incorporating i18n Into the Build System
Once your application is ready to be localized, the next step is to ensure that translation files are built automatically and kept up to date. This tutorial covers the necessary CMakeFiles.txt additions as well the process of distributing the resulting message catalogs with your application.
Common i18n Challenges and Solutions
This tutorial covers challenges that you may eventually run into such as translating handbooks and other data that exists outside of the source code, merging and handling obsolete .po files, dealing with freezes, coding in languages other than English and creating independent releases of or moving applications between KDE modules.
Semantic Markup of Messages
To ensure consistent presentation and more meaningful representations of messages in applications, semantic markup can be applied to messages marked for translation using the KUIT system. This tutorial describes how this system works.
Automated i18n Code Checking
The Krazy code checker scans KDE's code and reports common i18n mistakes.

Documentation

API Documentation
This tutorial explains how to document your APIs properly.
Man Pages
Writing and Generating Reference Manual Pages.
Source Code
http://quickgit.kde.org
http://websvn.kde.org

Accessibility

Accessibility Overview
A list of accessibility tutorials and general information.
Accessibility Checklist
What to look for in your application to make it accessible for as many people as possible.
Screen Reader
This tutorial will explain some details about using screen readers with KDE applications.
Text-To-Speech
How to utilize Jovie text-to-speech service in your application.

Application Automation and Scripting

D-Bus

Introduction to D-Bus
A straight-forward introduction to the core concepts in D-Bus from an application developer's perspective, this tutorial covers what D-Bus is and how it can be used by applications.
Accessing D-Bus Interfaces
A step-by-step guide to calling D-Bus methods and connecting to D-Bus signals using QtDBus.
Intermediate D-Bus
Tips to make use of QtDBus when faced with problematic real-world interfaces.
Creating D-Bus Interfaces
Learn how to expose functionality in your application by creating and using custom D-Bus interfaces. Covers generating the XML descriptions, instantiating interfaces at run time and setting up the build system with CMake.
Using Custom Types with D-Bus
Learn how to use your own types in classes exported on D-Bus. Covers marhaling and unmarshaling of objects, the integration of custom types into XML descriptions and registering the custom types with the Qt Meta Object system.
D-Bus Autostart Services
Turn your application into a D-Bus autostart service with this tutorial. This D-Bus feature, also known as "D-Bus service activation", will ensure that even when your application isn't running that D-Bus calls made to it will work by relying on the D-Bus daemon itself to start your app if and when needed.
Porting from DCOP to D-Bus
Port your applications from DCOP to D-Bus with this handy guide.

Konqueror

Creating Konqueror Service Menus
This tutorial shows you how to create mimetype-specific actions in Konqueror's context menu (aka "servicemenus").

Kross

Introduction to Kross
An introduction to the Kross Scripting Framework.
Hello World
A first application with working kross code.
Calling Functions in Kross
Simple demonstration of calling scripting functions
Connecting Signals and Slots in Kross
Simple demonstration of connecting object signals with script slots
Scripts as Plugins with Kross
This tutorial provides a step-by-step introduction how to integrate scripts as plugins into a KDE application.
Placing script actions in your application menus
Simple demonstration on how to extend you application menus to execute script files.
How to use an ActionCollection
A small Tutorial on How to use Kross::ActionCollections.

Calligra Plugin Tutorials

Calligra Overview
This document shows an overview of the different Calligra plugin types and tells you what each of their purpose and strengths are. If you are new with Calligra plugins, this is the place to start.
Calligra Plugin Creation
This gives a technical overview of what it means to write a Calligra plugin.
Creating Calligra Flake Plugins
This tutorial shows you how you can build a plugin for Calligra applications to allow you embed content in ODF documents using Flake.
Calligra Words Scripting
This tutorial shows how to script Calligra Words with Python, or JavaScript using Kross.
Calligra Sheets Scripting
This tutorial shows how to script Calligra Sheets with Python, or JavaScript using Kross.


SuperKaramba

SuperKaramba Tutorial
This tutorial provides an overview of SuperKaramba, theme files and scripting with Python, Ruby and JavaScript.

System Activity

Writing script actions for the process's context menu
This tutorial shows how to add a context menu action to show custom information about a process.

KWin

KWin Scripting Tutorial
This tutorial shows how to write a useful script for KWin.

Plugins and KParts

Using KParts
A kPart is a plugin that you can just load into your application. For example, it is easy to integrate an editor (the katePart) or a console (the konsolePart) into your application's window.
Writing kontact plugins
Kontact plugins are KParts. This tutorial describes how you can write one.
Writing Qt Designer Plugins
Add your widgets to Qt Designer and thus make them usable in UI files.

Search and Metadata

Strigi

Writing file analyzers
File analyzers extract data from files to display in the file dialogs and file managers. The data gathered this way is also used to search for files. KDE4 allows the use of multiple analyzers per file type. This tutorial describes how you can write new analyzers.

Nepomuk

See Nepomuk tutorials.


Hardware Awareness (Solid)

Introduction to Solid
An introduction to the Solid effort in general and it library in particular.
Listing Devices
How to use the Solid core library to discover the hardware and interact with the system.
Accessing Network Information
How to use the Solid system to get information about the network
Creating a Device Action
When your application is interested in registering actions with the system for removable hardware

Authorization and Privilege escalation (KAuth)

KAuth Basics
An overview of concepts and basic knowledge required to understand and use KAuth effectively
Using KAuth actions in your application
How to execute KAuth actions in your application, and how to integrate them tightly into your UI
Creating a KAuth helper to perform a privileged action
You will learn how to use KAuth's helpers and escalation facilities, and how to seamlessly make a privileged and non privileged portion of your application interact
Creating a KCM requiring authorization upon saving
Learn how to use the high level KCModule API to create KCModules handling authorization, and its UI integration, on their own

Multimedia (Phonon)

Phonon
How to start with the multimedia API
How to compile and use Phonon and its GStreamer backend on Linux using Qt 4.3.x
This article gives you a quick brief of how you can use checkout, compile Phonon and its GStreamer backend on GNU/Linux with just Qt 4.3.x. Towards the end, the article also describes how a developer can make use of Phonon to create simple audio and video players. You can read the article here. You can download the editable OpenDocumentText file from here.
Writing Backends
How to start creating a new backend for the multimedia API
Resources
Please have a look at the online documentation for information on the Phonon API. If you prefer using Qt Assistant or Qt Creator you can also use our offline documentation.

Plasma

See Plasma tutorials.


Personal Information Management (Akonadi)

Using Akonadi in Applications
Displaying and modifying data provided by Akonadi
Developing Akonadi Resources
Akonadi Resources are agent programs which transport PIM data between Akonadi and a backend (files, servers, etc)
Using custom data types with Akonadi
Akonadi can handle arbitrary data as item payloads through the use of a plugin based serialization framework
Porting Applications which use KResource API
Applications using KDE's now deprecated KResource APIs, e.g. KABC or KCal, need to be ported to use their Akonadi equivalents

Kate / Kwrite

Getting started with KTextEditor plugins
Creating your first KTextEditor plugin
Developing a plugin with configuration dialog
Adding a configuration dialog to the Time & Date example
A small Editor
Create a small application using KTextEditor

KDevelop

KDevelop-PG-Qt Introduction
Information on the KDevelop parser generator, useful for language plugins.

Printing

KDE mostly uses the Qt Printing infrastructure.

Hello World
Introduction to the KDE printing system

kioslaves

Collaboration

Open Collaboration Services (libattica)

Introduction to Attica
In this tutorial a simple widget showing information about a Person on the server is created.

Get Hot New Stuff

Get Hot New Stuff 3 - Download
How to use KHotNewStuff3 in your application.
Get Hot New Stuff 3 - Checking for Updates
How to check if updates for installed stuff are available without showing the dialog/widget.
Get Hot New Stuff 3 - Upload
How to add an upload dialog to your application.

Old links for KNS2 and KNS1 content:

Introduction to Get Hot New Stuff 2
A short tutorial about how to use KHotNewStuff2 in your application. Deprecated, use version 3
Introduction to Get Hot New Stuff
An introduction to the developer-friendly network update system that allows KDE applications to fetch new application data at runtime in a user friendly manner.
KNewStuff Secure (Original Link)
Tutorial showing how to share resources in a secured way (KDE 3.4 and later). By András Mantia <[email protected]>.

Goya

Introduction to Goya usage
An introduction for the Goya subsystem usage, which allows you to easily add widgets to your itemviews and connect their signals to your code, as they were real widgets.
Introduction to Goya usage (part 2)
The second part of the tutorial, with a slightly more complex example than the first part.

Other programming languages

Python

An Introduction to PyQt
Starting off
PyQt by Example
Another introduction to PyQt
PyKDE WebKit Tutorial
A simple web browser application in PyKDE
101 Introduction to signals and slots
A simple introduction to Qt's signal and slot architecture.
PyKDE DBus Tutorial
An introduction to DBus communication using PyKDE
PyKDE KNotify Tutorial
An introduction to Knotify (Notifications and KJobs) using PyKDE

Ruby

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.
Qt4 Ruby Tutorial
Nokia's fabulous introductory tutorial to Qt, translated to Ruby.
Creating a Plasma Widget in Ruby
Tutorial that shows how to create your first Plasma Applet using the Ruby language.
Developing Qt4 Applications using Qt Designer and Ruby on Kubuntu
Tutorial that shows how to design a simple User Interface in Qt Designer and then use the resulting widget in a Qt Ruby application we build from scratch.
Ruby-Qt/KDE Book
There is also an approach to create an Ruby-Qt/KDE Book under a free license. The content will be created in this wiki.

Shell

Shell Scripting with KDE dialogs (Original Link)
Tutorial by Brad Hards that describes how to use KDE dialogs in shell scripts with kdialog. It is presented as an example based tutorial.

Graphics Programming

QPainter Perfomance
Hints on avoiding common mistakes leading to poor performance when using QPainter

Using the KDE Games Libraries

KStandardGameAction
Using libkdegames to make your game fit the kdegames standard
Highscores
Implementing a simple highscore table into your game
Theme Selector
Using the libkdegames theme selection dialog
Palapeli Slicers
Creating a slicer plugin for Palapeli

KGLEngine

installation and your first KGLItem
start your first kglengine application
kglpong
Now use our knowledge to make a pong

Using the KDE PIM Libraries

iCalendar functionality
Using kcal to manage iCalendar files

Other tutorials

2D Plotting (KPlotWidget)

Using the KDE data-plotting widget
This tutorial introduces KPlotWidget, which is used for 2-D data plotting. It includes information on simple usage of the widget (including adding and modifying data sets, and customizing the plot axes and labels), and advanced customization (including extending the widget through sub-classing).

Spelling and Grammar Checking (Sonnet)

Adding spell-checking or grammar-checking to KDE applications
This tutorial introduces Sonnet and how one may use it to add language correction to your KDE application. Sonnet's auxiliary features shall be described in a separate tutorial.

Pixmap cache (KPixmapCache)

Using the KDE pixmap cache
This tutorial shows how to use KPixmapCache to cache e.g. pixmaps generated from SVGs or some data.

Using MarbleWidget (Marble)

Using MarbleWidget
This short tutorial describes how to use the MarbleWidget in your project

Using local SCM for KDE development

Using Git to develop for KDE
Here you find how to use Git to develop for KDE

Kwin effect tutorial (blog)

blog by Martin Graesslin
This tutorial guides you through the development of a simple KWin effect

Implementing KSysGuard sensors and adding them

Special:myLanguage/Development/Tutorials/Sensors
This tutorial shows how to write and KSysGuard sensor and connect it to the systray.

Runners

Porting an application from KSystemTrayIcon to KStatusNotifierItem

Special:myLanguage/Development/Tutorials/PortToKStatusNotifierItem
This tutorials shows how to port an application using KSystemTrayIcon to KStatusNotifierItem

Using the KDE Wallet API for safe storage

Special:myLanguage/Development/Tutorials/KWallet
"Brief introduction to the KWallet API which can be used for storing all kinds of sensitive information."

How to edit a wiki with Libmediawiki

Special:myLanguage/Development/Tutorials/Libmediawiki
This tutorial present how to edit a wiki with Libmediawiki.

KDE2 and KDE3 Materials

Porting Your Application from KDE 3 to KDE 4
These tutorials cover topics related to the migration from KDE 3 to KDE 4.
KDE3 Tutorials
These tutorials cover topics related to KDE3.
KDE2 Tutorials
These tutorials cover topics related to KDE2.