Development/Tutorials: Difference between revisions

From KDE TechBase
(add phonon backends)
(→‎Shell: Use link to moved section for moved pages)
 
(160 intermediate revisions by 35 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Development/Tutorials}}
These tutorials were updated and moved to https://develop.kde.org/docs/


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.
[[Category:MovedDevelop]]


== Introduction To KDE 4 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]]
:''A preliminary introduction to the very basics of KDE4 programming''


;[[Development/Tutorials/Using KXmlGuiWindow|Creating the Main Window]]
Below is the old version of this wiki page.
:''This tutorial shows you the magic of an application's most important thing: The main window.''


;[[Development/Tutorials/Using KActions|Using KActions]]
:''How to add actions to the menus and toolbars.''


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


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


== Basics ==
<translate>
;[[Development/Tutorials/KDE4 Porting Guide|Porting Your Application]]
:''Help Porting Applications from Qt3/KDE3 to Qt4/KDE4''
 
;[[Development/Tutorials/CMake|Introduction to CMake]]
:''How to use the CMake build system used by KDE4.''
 
;[[Development/Tutorials/Common Programming Mistakes|Common Programming Mistakes]]
:''Various common mistakes made while developing Qt and KDE applications and how to avoid them.''
 
;[[Development/Tutorials/Debugging Linker Errors|Debugging Linker Errors]]
:'How to understand and debug errors from the linker, at compile time.''
 
;[[Development/Tutorials/Using Qt Designer|Using Qt Designer to build user interfaces]]
:''How to create UI files with designer, and how to integrate them into a KDE program.''
 
;[[Development/Tutorials/Using Qt Creator|Using Qt Creator to develop your KDE program]]
:''How to integrate Qt Creator use into KDE development.''
 
;[[Development/Tutorials/Creating Libraries|Creating Libraries to share code]]
:''How to add the library to the buildsystem and how to prepare the source code.''
 
;[[Development/Tutorials/Session_Management|Session Management]]
:''Make your application aware of X sessions''
 
== Testing And Debugging ==
 
;[[Development/Tutorials/Debugging|Debugging your 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])
:''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]]
:''Techniques you can use to detect errors in KDE code''
 
== Managing Configuration Data With KConfig ==
;[[Development/Tutorials/KConfig|Introduction To KConfig]]
:''An overview of the KConfig classes and how to use them in your application code''
 
;[[Development/Tutorials/Using KConfig XT|Using KConfig XT]]
:''Tutorial on how to efficiently use the KConfig XT framework.''
 
;[[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''
 
== Services: Applications and Plugins ==
;[[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.''
 
;[[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''


;[[Development/Tutorials/Services/Plugins|Creating and Loading Plugins Using KService]]
<!--T:2-->
:''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.''
Here is a list of currently available tutorials for developing KDE Applications or KDE Plasma, or using KDE Frameworks to develop a 3rd-party application.


== Localization ==
== Basics of how to develop with KDE Frameworks == <!--T:3-->
See also [[Localization|Localization portal]].


;[[Development/Tutorials/Localization/Unicode|Introduction To Unicode]]
These tutorials were moved to [https://develop.kde.org/docs/getting-started/kxmlgui/ Getting Started with KXmlGui].
:''An introduction to what Unicode is as well as how to handle Unicode data in KDE applications.''
Not yet moved pages:
<!--T:4--></translate>
;[[Special:myLanguage/Development/Tutorials/Common Programming Mistakes|<translate><!--T:21-->
Common Programming Mistakes</translate>]]
:<translate><!--T:22-->
Various common mistakes made while developing Qt and KDE applications and how to avoid them.</translate>


; [[Development/Tutorials/Localization/i18n|Writing Applications With Localization In Mind]]
== Integrating with Workspaces ==
:''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]]
These tutorials were moved to [https://develop.kde.org/docs/features/ Features]. Not yet moved pages:
:''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/Tutorial/Icons|<translate><!--T:31-->
:''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.''
Icons</translate>]]
:<translate><!--T:32-->
Deliver your application with icons that are automatically installed to the right places. Based on the [https://develop.kde.org/docs/getting-started/kxmlgui/using_actions/ Kaction Tutorial].</translate><translate>


; [[Development/Tutorials/Localization/i18n Build Systems|Incorporating i18n Into the Build System]]
== Managing Configuration Data With KConfig == <!--T:43-->
:''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]]
These tutorials were moved to [https://develop.kde.org/docs/features/configuration/ Configuration]. Not yet moved pages:
:''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]]
</translate>
:''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.''
;[[Special:myLanguage/Development/Tutorials/Updating KConfig Files|<translate><!--T:48-->
Updating KConfig Files</translate>]]
:<translate><!--T:49-->
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


; [[Development/Tutorials/Localization/i18n Krazy|Automated i18n Code Checking]]
== Services : Applications and Plugins == <!--T:50-->
:''The Krazy code checker scans KDE's code and reports common i18n mistakes.''


== Documentation ==
</translate>
;[[Special:myLanguage/Development/Tutorials/Services/Introduction|<translate><!--T:51-->
Introduction to the Services Framework</translate>]]
:<translate><!--T:301-->
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.</translate>
;[[Special:myLanguage/Development/Tutorials/Services/Traders|<translate><!--T:52-->
Finding Services Using Trader Queries</translate>]]
:<translate><!--T:53-->
How to find services, such as plugins or mimetypes, that are indexed in the SyCoCa using Trader Query Syntax</translate>
;[[Special:myLanguage/Development/Tutorials/Services/Plugins|<translate><!--T:54-->
Creating and Loading Plugins Using KService</translate>]]
:<translate><!--T:312-->
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.


;[[Development/Tutorials/API_Documentation|API Documentation]]
== Localization == <!--T:55-->
:''This tutorial explains how to document your APIs properly.''


;[[Development/Tutorials/Man_Pages|Man Pages]]
<!--T:56-->
:''Writing and Generating Reference Manual Pages.''
See also [[Special:myLanguage/Localization|Localization portal]].
</translate>
;[[Development/Tutorials/Localization/Unicode|<translate><!--T:57-->
Introduction To Unicode</translate>]]
:<translate><!--T:311-->
An introduction to what Unicode is as well as how to handle Unicode data in KDE applications.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n|<translate><!--T:58-->
Writing Applications With Localization In Mind</translate>]]
:<translate><!--T:59-->
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.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Mistakes|<translate><!--T:60-->
Avoiding Common Localization Pitfalls</translate>]]
:<translate><!--T:61-->
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.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/Building KDE's l10n Module|<translate><!--T:62-->
Building KDE's Localization Module</translate>]]
:<translate><!--T:63-->
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.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Build Systems|<translate><!--T:64-->
Incorporating i18n Into the Build System</translate>]]
:<translate><!--T:65-->
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.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Challenges|<translate><!--T:66-->
Common i18n Challenges and Solutions</translate>]]
:<translate><!--T:67-->
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.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n_Semantics|<translate><!--T:68-->
Semantic Markup of Messages</translate>]]
:<translate><!--T:69-->
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.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Krazy|<translate><!--T:70-->
Automated i18n Code Checking</translate>]]
:<translate><!--T:71-->
The Krazy code checker scans KDE's code and reports common i18n mistakes.
; [[Special:myLanguage/Development/Tutorials/Localization/Language_Change|Dealing with Language Changes]]
:This tutorial covers dealing with changing languages: How to add the function to change the language and then dynamically update the user interface when language has been changed.
; [[Special:myLanguage/Development/Tutorials/Localization/Message_Appearance|Understanding How Messages Appear to Translators]]
:An introduction to what context information is extracted (and what isn't) from source code for translators to see.


;Source Code
</translate>
: http://websvn.kde.org
<translate>
== Application Automation and Scripting == <!--T:85-->


== Accessibility ==
=== D-Bus === <!--T:86-->
</translate>


;[[Development/Tutorials/Accessibility|Accessibility]]
These tutorials were moved to [https://develop.kde.org/docs/features/d-bus/ D-Bus]. Not yet moved pages:
:''This tutorial will explain how to make your application accessible.''
; [[Special:myLanguage/Development/Tutorials/D-Bus/Intermediate_D-Bus|<translate><!--T:91-->
Intermediate D-Bus</translate>]]
:<translate><!--T:92-->
Tips to make use of QtDBus when faced with problematic real-world interfaces.</translate>
; [[Special:myLanguage/Development/Tutorials/D-Bus/Creating Interfaces|<translate><!--T:93-->
Creating D-Bus Interfaces</translate>]]
:<translate><!--T:94-->
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.</translate>
; [[Special:myLanguage/Development/Tutorials/D-Bus/CustomTypes|<translate><!--T:95-->
Using Custom Types with D-Bus</translate>]]
:<translate> <!--T:96-->
Learn how to use your own types in classes exported on D-Bus. Covers marshaling and unmarshaling of objects, the integration of custom types into XML descriptions and registering the custom types with the Qt Meta Object system.</translate>
; [[Special:myLanguage/Development/Tutorials/D-Bus/Autostart Services|<translate><!--T:97-->
D-Bus Autostart Services</translate>]]
:<translate><!--T:98-->
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.</translate>


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


== Application Automation and Scripting ==
=== Dolphin === <!--T:101-->
</translate>


=== D-Bus ===
These tutorials were moved to [https://develop.kde.org/docs/apps/dolphin/ Dolphin].
; [[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.''
; [[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.''
; [[Development/Tutorials/D-Bus/Intermediate_D-Bus|Intermediate D-Bus]]
:''Tips to make use of QtDBus when faced with problematic real-world interfaces.''
; [[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.''
; [[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]]
:''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]]
: ''Port your applications from DCOP to D-Bus with this handy guide.''
 
=== Konqueror ===
; [[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").''


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


; [[Development/Tutorials/Kross/Hello_World|Hello World]]
; [[Special:myLanguage/Development/Tutorials/Kross/Introduction|<translate><!--T:104-->
:''A first application with working kross code.''
Introduction to Kross</translate>]]
:<translate><!--T:105-->
An introduction to the Kross Scripting Framework.</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Hello_World|<translate><!--T:106-->
Hello World</translate>]]
:<translate><!--T:107-->
A first application with working kross code.</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Call_Functions_in_Kross|<translate><!--T:108-->
Calling Functions in Kross</translate>]]
:<translate><!--T:109-->
Simple demonstration of calling scripting functions</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Connecting_Signals_and_slots_in_Kross|<translate><!--T:110-->
Connecting Signals and Slots in Kross</translate>]]
:<translate><!--T:111-->
Simple demonstration of connecting object signals with script slots</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Scripts-as-Plugins|<translate><!--T:112-->
Scripts as Plugins with Kross</translate>]]
:<translate><!--T:113-->
This tutorial provides a step-by-step introduction how to integrate scripts as plugins into a KDE application.</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Script-Actions|<translate><!--T:114-->
Placing script actions in your application menus </translate>]]
:<translate><!--T:115-->
Simple demonstration on how to extend you application menus to execute script files.</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/ActionCollections|<translate><!--T:116-->
How to use an ActionCollection</translate>]]
:<translate><!--T:117-->
A small Tutorial on How to use Kross::ActionCollections.</translate>
{{:Projects/Calligra/Plugin Tutorials}}
<translate>
=== System Activity === <!--T:121-->
</translate>


; [[Development/Tutorials/Kross/Call_Functions_in_Kross|Calling Functions in Kross]]
; [[Special:myLanguage/Development/Tutorials/SystemActivity/Scripting|<translate><!--T:122-->
:''Simple demonstration of calling scripting functions''
Writing script actions for the process's context menu</translate>]]
:<translate><!--T:123-->
This tutorial shows how to add a context menu action to show custom information about a process.


; [[Development/Tutorials/Kross/Connecting_Signals_and_slots_in_Kross|Connecting Signals and Slots in Kross]]
=== KWin === <!--T:124-->
:''Simple demonstration of connecting object signals with script slots''
</translate>


; [[Development/Tutorials/Kross/Scripts-as-Plugins|Scripts as Plugins with Kross]]
These tutorials were moved to [https://develop.kde.org/docs/plasma/kwin/ KWin Scripting Tutorial]. Not yet moved pages:
:''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 ]]
<translate><!--T:300-->
:''Simple demonstration on how to extend you application menus to execute script files.''
; [[Development/Tutorials/KWin/WindowSwitcher|QML Window Switcher Layouts]]
: This tutorial documents the new QML layouts for the KWin Window Switcher


; [[Development/Tutorials/Kross/ActionCollections|How to use an ActionCollection ]]
== Plugins and KParts == <!--T:127-->
:''A small Tutorial on How to use Kross::ActionCollections.''
</translate>
{{:KOffice/Plugin Tutorials}}


=== SuperKaramba ===
; [[Special:myLanguage/Development/Tutorials/Using KParts|<translate><!--T:128-->
; [[Development/Tutorials/SuperKaramba|SuperKaramba Tutorial]]
Using KParts</translate>]]
:''This tutorial provides an overview of SuperKaramba, theme files and scripting with Python, Ruby and JavaScript.''
:<translate><!--T:129-->
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.</translate>
; [[Special:myLanguage/Development/Tutorials/Writing kontact plugins|<translate><!--T:130-->
Writing kontact plugins</translate>]]
:<translate><!--T:131-->
Kontact plugins are KParts. This tutorial describes how you can write one.</translate>
; [https://community.kde.org/Get_Involved/development/Tutorials/Writing_Qt_Designer_Plugins <translate><!--T:132-->
Writing Qt Designer Plugins</translate>]
<translate><!--T:133-->
:Add your widgets to Qt Designer and thus make them usable in UI files.
; [[Special:myLanguage/Development/Tutorials/KCM_HowTo|KCM HowTo]]
:KCM are plugins which are loaded by System Settings to display configuration elements. They can also be used within an application.


=== System Activity ===
== Hardware Awareness (Solid) == <!--T:139-->
</translate>


: [[Development/Tutorials/SystemActivity/Scripting|Writing script actions for the process's context menu]]
;[[Special:myLanguage/Development/Tutorials/Solid/Introduction|<translate><!--T:140-->
:''This tutorial shows how to add a context menu action to show custom information about a process.
Introduction to Solid</translate>]]
:<translate><!--T:141-->
An introduction to the Solid effort in general and it library in particular.</translate>
;[[Special:myLanguage/Development/Tutorials/Solid/Device_Discovery|<translate><!--T:142-->
Listing Devices</translate>]]
:<translate><!--T:143-->
How to use the Solid core library to discover the hardware and interact with the system.</translate>
;[[Special:myLanguage/Development/Tutorials/Solid/Network_Management|<translate><!--T:144-->
Accessing Network Information</translate>]]
:<translate><!--T:145-->
How to use the Solid system to get information about the network</translate>
;[[Special:myLanguage/Development/Tutorials/Solid/Device_Actions|<translate><!--T:146-->
Creating a Device Action</translate>]]
:<translate><!--T:147-->
When your application is interested in registering actions with the system for removable hardware


== Plugins and KParts ==
== Authorization and Privilege escalation (KAuth) == <!--T:148-->
</translate>


; [[Development/Tutorials/Writing kontact plugins|Writing kontact plugins]]:''Kontact plugins are KParts. This tutorial describes how you can write one.''
These tutorials were moved to [https://develop.kde.org/docs/features/kauth/ KAuth]. Not yet moved pages:


; [[Development/Tutorials/Using KParts|Using KParts]]:''Learn how to load a KPart into an application window.''
; [[Special:myLanguage/Development/Tutorials/KAuth/Helper_HowTo|<translate><!--T:153-->
Creating a KAuth helper to perform a privileged action</translate>]]
:<translate><!--T:154-->
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</translate>
; [[Special:myLanguage/Development/Tutorials/KAuth/KCM_HowTo|<translate><!--T:155-->
Creating a KCM requiring authorization upon saving</translate>]]
:<translate><!--T:156-->
Learn how to use the high level KCModule API to create KCModules handling authorization, and its UI integration, on their own


; [[Development/Tutorials/Writing Qt Designer Plugins|Writing Qt Designer Plugins]]:''Add your widgets to Qt Designer and thus make them usable in UI files.''
== Multimedia (Phonon) == <!--T:157-->
</translate>


== Search and Metadata ==
;[[Special:myLanguage/Development/Tutorials/Phonon/Introduction|<translate><!--T:158-->
Phonon</translate>]]
:<translate><!--T:159-->
[[Special:myLanguage/Development/Tutorials/Phonon/Introduction|Introduction to Phonon]] tells how to compile and run the code.  If you like to work in Python, try [[Development/Tutorials/Phonon/Introduction/Python|this version]] of the same tutorial</translate>
;[[Special:myLanguage/Development/Tutorials/Phonon/Backends|<translate><!--T:160-->
Writing Backends</translate>]]
:<translate><!--T:161-->
How to start creating a new backend for the multimedia API</translate>
<translate><!--T:162-->
;Resources</translate>
<translate><!--T:163-->
:Please have a look at the [https://api.kde.org/phonon/html/index.html online documentation] for information on the Phonon API. If you prefer using Qt Assistant or Qt Creator you can also use our [https://api.kde.org/qch/phonon.qch offline documentation].
</translate>


=== Strigi ===
<translate>
== Plasma 5== <!--T:307-->
</translate>


; [[Development/Tutorials/Writing file analyzers|Writing file analyzers]]
<translate><!--T:308-->
:''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.''
See [[Special:myLanguage/Development/Tutorials/Plasma5|Plasma tutorials]].</translate>


=== [http://nepomuk.kde.org Nepomuk] ===
<translate>
== Personal Information Management (Akonadi) == <!--T:166-->
</translate>


; [[Development/Tutorials/Metadata/Nepomuk/Quickstart|Nepomuk Quickstart]]
;[[Special:myLanguage/Development/Tutorials/Akonadi/Application|<translate><!--T:167-->
:''How to use Nepomuk resources in a quick and painless way without much fuss.''
Using Akonadi in Applications</translate>]]
:<translate><!--T:168-->
Displaying and modifying data provided by Akonadi</translate>
;[[Special:myLanguage/Development/Tutorials/Akonadi/Resources|<translate><!--T:169-->
Developing Akonadi Resources</translate>]]
:<translate><!--T:170-->
Akonadi Resources are agent programs which transport PIM data between Akonadi and a backend (files, servers, etc)</translate>
;[[Special:myLanguage/Development/Tutorials/Akonadi/SerializerPlugin|<translate><!--T:171-->
Using custom data types with Akonadi</translate>]]
:<translate><!--T:172-->
Akonadi can handle arbitrary data as item payloads through the use of a plugin based serialization framework</translate>


; [[Development/Tutorials/Metadata/Nepomuk/RDFIntroduction|RDF and Ontologies in Nepomuk]]
<translate>
:''An introduction to RDF and the usage of ontologies in Nepomuk.''
== Kate / KWrite == <!--T:175-->
</translate>


; [[Development/Tutorials/Metadata/Nepomuk/DataLayout|Data Layout in Nepomuk]]
;[[Special:myLanguage/Development/Tutorials/Kate/KTextEditor Plugins|<translate><!--T:176-->
:''An overview of which and how data is stored in Nepomuk.''
Getting started with KTextEditor plugins</translate>]]
:<translate><!--T:177-->
Creating your first KTextEditor plugin</translate>
;[[Special:myLanguage/Development/Tutorials/Kate/KTextEditor_Plugins_Advanced|<translate><!--T:178-->
Developing a plugin with configuration dialog</translate>]]
:<translate><!--T:179-->
Adding a configuration dialog to the Time & Date example</translate>
;[[Special:myLanguage/Development/Tutorials/Kate/KTextEditor_Example|<translate><!--T:180-->
A small Editor</translate>]]
:<translate><!--T:181-->
Create a small application using KTextEditor


; [[Development/Tutorials/Metadata/Nepomuk/Resources|Handling Resources with Nepomuk]]
== KDevelop == <!--T:182-->
:''Nepomuk is the KDE library which provides easy access to metadata in the Nepomuk system. Learn how to make your application create and read metadata using the Nepomuk system.''
</translate>


; [[Development/Tutorials/Metadata/Nepomuk/ResourceGenerator|Using the Nepomuk Resource Generator]]
;[[Special:myLanguage/Development/Tutorials/KDevelop/Creating_a_class_template|<translate>
:''Nepomuk includes a resource generator which creates convenience classes for handling metadata.''
<!--T:302-->
Creating a class template</translate>]]
:<translate>
<!--T:303-->
Instructions for creating a class template, which can be used to quickly generate classes from KDevelop.
</translate>
;[[Special:myLanguage/Development/Tutorials/KDevelop/Creating_a_project_template|<translate>
<!--T:304-->
Creating a project template</translate>]]
:<translate>
<!--T:305-->
Instructions for creating a project template, which can be used for starting new project with KDevelop.
</translate>
;[[Special:myLanguage/Development/KDevelop-PG-Qt_Introduction|<translate><!--T:183-->
KDevelop-PG-Qt Introduction</translate>]]
:<translate>
<!--T:310-->
Information on the KDevelop parser generator, useful for language plugins.
</translate><translate>


; [[Development/Tutorials/Metadata/Nepomuk/NepomukQuery|Using the Nepomuk Query API]]
== Printing == <!--T:185-->
:''Starting with KDE 4.4 Nepomuk provides a desktop query API.''
</translate>
<translate>
<!--T:186-->
KDE mostly uses the [http://doc.qt.nokia.com/latest/printing.html Qt Printing infrastructure].
</translate>


; [[Development/Tutorials/Metadata/Nepomuk/AdvancedQueries|Advanced Queries]]
;[[Special:myLanguage/Development/Tutorials/Printing Hello World|<translate><!--T:187-->
:''The real power of Nepomuk can only be exposed when performing fancy queries on the data repository. This tutorial provides an introduction to semantic and full text queries in Nepomuk.''
Hello World</translate>]]
:<translate><!--T:188-->
Introduction to the KDE printing system


; [[Development/Tutorials/Metadata/Nepomuk/NepomukServer|The Nepomuk Server and the Architecture of the Nepomuk subsystem]]
== kioslaves == <!--T:189-->
:''The Nepomuk Server hosts the main Nepomuk data repository and can be accessed directly via a Soprano API.''
</translate>


; [[Development/Tutorials/Metadata/Nepomuk/NepomukServices|Nepomuk Services]]
* [[Special:myLanguage/Development/Tutorials/KIO Slaves/Using KIO Slaves in your Program|<translate><!--T:190-->
:''The Nepomuk Server manages a set of Nepomuk services.''
Using kioslaves in your Program</translate>]]
:* [[Development/Tutorials/Metadata/Nepomuk/StorageService|Storage Service]] ''The probably most important service hosts the Nepomuk data repository using [http://soprano.sourceforge.net Soprano].''
* [[Special:myLanguage/Development/Tutorials/KIO Slaves/Hello World|<translate><!--T:191-->
:* [[Development/Tutorials/Metadata/Nepomuk/OntologyLoaderService|Ontology Loader]] ''Makes sure installed ontologies such as RDF, RDFS, NRL, or Xesam are loaded into the storage repository.''
Creating a Hello-World kioslave</translate>]]
:* [[Development/Tutorials/Metadata/Nepomuk/FileWatchService|File Watch Service]] ''Monitors the file system for changes and updates the file resource paths and URIs in Nepomuk.''
<translate>
:* [[Development/Tutorials/Metadata/Nepomuk/StrigiService|Strigi Service]] ''Controls Strigi, the file indexing tool which extracts metadata from files and stores it into the storage repository.''
== Collaboration == <!--T:192-->
:* [[Development/Tutorials/Metadata/Nepomuk/QueryService|Query Service]] ''Provides persistant query folders.''


; [[Development/Tutorials/Metadata/Nepomuk/TipsAndTricks|Nepomuk Tips and Tricks]]
=== Open Collaboration Services (libattica) === <!--T:193-->
:''A set of tips and tricks for development with Nepomuk and Soprano. This is a must-read if you intend to use Nepomuk in your application or hack on it directly.''
</translate>
;[[Special:myLanguage/Development/Tutorials/Collaboration/Attica/Introduction|<translate><!--T:194-->
Introduction to Attica</translate>]]
:<translate><!--T:195-->
In this tutorial a simple widget showing information about a Person on the server is created.


== Hardware Awareness (Solid) ==
=== Get Hot New Stuff  === <!--T:196-->
</translate>


;[[Development/Tutorials/Solid_Tutorials|Introduction to Solid]]
;[[Special:myLanguage/Development/Tutorials/Collaboration/HotNewStuff/Introduction|<translate><!--T:197-->
:''An introduction to using the Solid hardware discovery and interaction system in KDE applications.''
Get Hot New Stuff 3 - Download</translate>]]
:<translate><!--T:198-->
How to use KHotNewStuff3 in your application.</translate>
;[[Special:myLanguage/Development/Tutorials/Collaboration/HotNewStuff/Updates|<translate><!--T:199-->
Get Hot New Stuff 3 - Checking for Updates</translate>]]  
:<translate><!--T:200-->
How to check whether updates for installed stuff are available without showing the dialog/widget.</translate>
;[[Special:myLanguage/Development/Tutorials/Collaboration/HotNewStuff/Upload|<translate><!--T:201-->
Get Hot New Stuff 3 - Upload</translate>]]
:<translate><!--T:202-->
How to add an upload dialog to your application.


;[[Development/Tutorials/Solid_Network_Tutorial|Accessing Network Information]]
== Other programming languages == <!--T:216-->
:''How to use the Solid system to get information about the network''


;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Action]]
=== Python (PyQt4) === <!--T:217-->
:''When your application is interested in registering actions with the system for removable hardware''


== Authorization and Privilege escalation (KAuth) ==
<!--T:325-->
; [[Development/Tutorials/KAuth/KAuth_Basics|KAuth Basics]]
{{Note|The tutorials below apply to an older version of Qt only. While there are stable Python bindings available for Qt 5, bindings for KDE Frameworks 5 are still under development.}}
:''An overview of concepts and basic knowledge required to understand and use KAuth effectively''
</translate>
; [[Development/Tutorials/KAuth/KAuth_Actions|Using KAuth actions in your application]]
;[http://www.learningpython.com/2008/09/20/an-introduction-to-pyqt/ <translate><!--T:218-->
:''How to execute KAuth actions in your application, and how to integrate them tightly into your UI''
An Introduction to PyQt</translate>]
; [[Development/Tutorials/KAuth/Helper_HowTo|Creating a KAuth helper to perform a privileged action]]
:<translate><!--T:219-->
:''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''
Starting off with an introduction to PyQt4</translate>
; [[Development/Tutorials/KAuth/KCM_HowTo|Creating a KCM requiring authorization upon saving]]
;[[Special:myLanguage/Development/Languages/Python/Using_PyKDE_4|Using PyKDE4]]
:''Learn how to use the high level KCModule API to create KCModules handling authorization, and its UI integration, on their own''
:Introduction to PyKDE4
;[[Special:myLanguage/Development/Languages/Python/PyKDE_WebKit_Tutorial|<translate><!--T:222-->
PyKDE WebKit Tutorial</translate>]]
:<translate><!--T:223-->
A simple web browser application in PyKDE</translate>
;[[Special:myLanguage/Development/Tutorials/Python introduction to signals and slots|<translate><!--T:224-->
101 Introduction to signals and slots</translate>]]
:<translate><!--T:225-->
A simple introduction to Qt's signal and slot architecture.</translate>
;[[Special:myLanguage/Development/Languages/Python/PyKDE_DBus_Tutorial|<translate><!--T:226-->
PyKDE DBus Tutorial</translate>]]
:<translate><!--T:227-->
An introduction to DBus communication using PyKDE</translate>
;[[Special:myLanguage/Development/Languages/Python/PyKDE_Knotify_Tutorial|<translate><!--T:228-->
PyKDE KNotify Tutorial</translate>]]
:<translate>
<!--T:314-->
An introduction to Knotify (Notifications and KJobs) using PyKDE


== Multimedia (Phonon) ==
=== Ruby === <!--T:229-->


;[[Development/Tutorials/Phonon/Introduction|Phonon]]
<!--T:326-->
:''How to start with the multimedia API''
{{Note|The tutorials below apply to an older version of Qt only. There are currently no Ruby bindings for Qt 5 and KDE Frameworks 5 available.}}
</translate>
;[http://developer.kde.org/language-bindings/ruby/kde3tutorial/index.html <translate><!--T:230-->
KDE Ruby Korundum tutorial</translate>]
:<translate><!--T:231-->
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.</translate>
;[[Special:myLanguage/Development/Tutorials/Qt4_Ruby_Tutorial|<translate><!--T:232-->
Qt4 Ruby Tutorial</translate>]]
:<translate><!--T:233-->
Nokia's fabulous introductory tutorial to Qt, translated to Ruby.</translate>
;[[Special:myLanguage/Development/Tutorials/Plasma/RubyApplet|<translate><!--T:234-->
Creating a Plasma Widget in Ruby</translate>]]
:<translate><!--T:235-->
Tutorial that shows how to create your first Plasma Applet using the Ruby language.</translate>
;[[Special:myLanguage/Development/Tutorials/Developing_Qt4_Applications_using_Qt_Designer_and_Ruby_on_Kubuntu|<translate><!--T:236-->
Developing Qt4 Applications using Qt Designer and Ruby on Kubuntu</translate>]]
:<translate><!--T:237-->
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.</translate>
;[[Special:myLanguage/Development/Languages/Ruby/Ruby-Qt/KDE_Book|<translate><!--T:238-->
Ruby-Qt/KDE Book</translate>]]
:<translate>
<!--T:315-->
There is also an approach to create an Ruby-Qt/KDE Book under a free license. The content will be created in this wiki.


:''How to compile and use Phonon and its GStreamer backend on Linux using Qt 4.3.x''
=== Shell === <!--T:239-->
::''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].''
</translate>
This tutorial was moved to [https://develop.kde.org/docs/administration/kdialog/ Shell Scripting with KDE Dialogs].
<translate>


;[[Development/Tutorials/Phonon/Backends|Writing Backends]]
== Graphics Programming == <!--T:243-->
:''How to start creating a new backend for the multimedia API''
</translate>


== Plasma ==
;[[Special:myLanguage/Development/Tutorials/Graphics/Performance|<translate><!--T:244-->
QPainter Perfomance</translate>]]
:<translate><!--T:245-->
Hints on avoiding common mistakes leading to poor performance when using QPainter
</translate>


See [[Development/Tutorials/Plasma|Plasma tutorials]].
;[[Special:myLanguage/Development/Tutorials/Graphics/HiDPI|<translate><!--T:318-->
HiDPI Support</translate>]]


:<translate><!--T:319-->
How to render sharp GUI for HiDPI display</translate>


;[[Special:myLanguage/Development/Tutorials/Graphics/Migrate Qt Quick Controls 1|<translate><!--T:320--> Migrate Qt Quick Controls 1</translate>]]


== Personal Information Management (Akonadi) ==
:<translate><!--T:321--> Qt Quick Controls 1 is not supported so please follow the guide to upgrade to Qt Quick Controls 2</translate>
<translate>


;[[Development/Tutorials/Akonadi/Application|Using Akonadi in Applications]]
== Using the KDE Games Libraries == <!--T:246-->
:''Displaying and modifying data provided by Akonadi''
</translate>


;[[Development/Tutorials/Akonadi/Resources|Developing Akonadi Resources]]
;[[Special:myLanguage/Development/Tutorials/Games/KStandardGameAction|<translate> <!--T:247-->
:''Akonadi Resources are agent programs which transport PIM data between Akonadi and a backend (files, servers, etc)''
KStandardGameAction</translate>]]
:<translate><!--T:248-->
Using libkdegames to make your game fit the kdegames standard</translate>
;[[Special:myLanguage/Development/Tutorials/Games/Highscores| <translate><!--T:249-->
Highscores</translate>]]
:<translate><!--T:250-->
Implementing a simple highscore table into your game</translate>
;[[Special:myLanguage/Development/Tutorials/Games/Theme Selector|<translate> <!--T:251-->
Theme Selector</translate>]]
:<translate><!--T:252-->
Using the libkdegames theme selection dialog</translate>
;[[Special:myLanguage/Development/Tutorials/Games/Palapeli Patterns|<translate> <!--T:253-->
Palapeli Slicers</translate>]]
:<translate><!--T:254-->
Creating a slicer plugin for Palapeli
</translate>


;[[Development/Tutorials/Akonadi/SerializerPlugin|Using custom data types with Akonadi]]
<translate>== Other tutorials == <!--T:261-->
:''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]]
=== 2D Plotting (KPlotWidget) === <!--T:262-->
:''Applications using KDE's now deprecated KResource APIs, e.g. KABC or KCal, need to be ported to use their Akonadi equivalents''
</translate>


== Kate / Kwrite ==
;[[Special:myLanguage/Development/Tutorials/KPlotWidget|<translate><!--T:263-->
Using the KDE data-plotting widget</translate>]]
:<translate><!--T:264-->
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).</translate>


;[[Development/Tutorials/Kate/KTextEditor Plugins|Getting started with KTextEditor plugins]]
;[[Special:myLanguage/Development/Tutorials/Physical_Simulation|<translate><!--T:11-->
:''Creating your first KTextEditor plugin''
Physical Simulation</translate>]]
:<translate><!--T:12-->
How to perform a physical simulation: animation and diagram


;[[Development/Tutorials/Kate/KTextEditor_Plugins_Advanced|Developing a plugin with configuration dialog]]
=== Spelling and Grammar Checking (Sonnet) === <!--T:265-->
:''Adding a configuration dialog to the Time & Date example''
</translate>


;[[Development/Tutorials/Kate/KTextEditor_Example|A small Editor]]
;[[Special:myLanguage/Development/Tutorials/Sonnet/SonnetTutorial|<translate><!--T:266-->
:''Create a small application using KTextEditor''
Adding spell-checking or grammar-checking to KDE applications</translate>]]
:<translate><!--T:267-->
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.


== KDevelop ==
=== Using the KDE Wallet API for safe storage === <!--T:285-->
</translate>


;[[Development/KDevelop-PG-Qt_Introduction|KDevelop-PG-Qt Introduction]]
;[[Special:myLanguage/Development/Tutorials/KWallet|<translate><!--T:286-->
:''Information on the KDevelop parser generator, useful for language plugins.''
KWallet</translate>]]
:<translate><!--T:287-->
"Brief introduction to the KWallet API which can be used for storing all kinds of sensitive information."


==Printing==
== Deprecated Material == <!--T:317-->
{{Warning|Tutorials in this section are outdated and are no longer relevant to the current state of KDE software. They are being retained here for historical purposes only. Please do not use them.}}


;[[Development/Tutorials/Printing Hello World|Hello World]]
;[[Development/Tutorials/KDE4 Porting Guide|Porting Your Application to KDE4]]
:''Introduction to the KDE printing system''
:''Help Porting Applications from Qt3/KDE3 to Qt4/KDE4''


;[[Development/Tutorials/Printing Print Dialog|Print Dialog]]
:''Using the KDE print dialog''


== kioslaves ==
=== Accessibility === <!--T:313-->
* [[Development/Tutorials/KIO Slaves/Using KIO Slaves in your Program|Using kioslaves in your Program]]
</translate>
* [[Development/Tutorials/KIO Slaves/Hello World|Creating a Hello-World kioslave]]
;[[Special:myLanguage/Development/Tutorials/Accessibility|<translate><!--T:77-->
 
Accessibility Overview</translate>]]
== Collaboration ==
:<translate><!--T:78-->
 
A list of accessibility tutorials and general information.</translate>
=== Open Collaboration Services (libattica) ===
;[[Special:myLanguage/Development/Tutorials/Accessibility/Checklist|<translate><!--T:79-->
 
Accessibility Checklist</translate>]]
;[[Development/Tutorials/Collaboration/Attica/Introduction|Introduction to Attica]]
:<translate><!--T:80-->
:''In this tutorial a simple widget showing information about a Person on the server is created.''
What to look for in your application to make it accessible for as many people as possible.</translate>
 
;[[Special:myLanguage/Development/Tutorials/Accessibility/Screen_Reader_Setup|<translate><!--T:81-->
=== Get Hot New Stuff  ===
Screen Reader</translate>]]
 
:<translate><!--T:82-->
;[[Development/Tutorials/Collaboration/HotNewStuff/Introduction|Get Hot New Stuff 3 - Download]]
This tutorial will explain some details about using screen readers with KDE applications.</translate>
:''How to use KHotNewStuff3 in your application.''<br>
;[[Special:myLanguage/Development/Tutorials/Text-To-Speech|<translate><!--T:83-->
 
Text-To-Speech</translate>]]
;[[Development/Tutorials/Collaboration/HotNewStuff/Updates|Get Hot New Stuff 3 - Checking for Updates]]
:<translate><!--T:84-->
:''How to check if updates for installed stuff are available without showing the dialog/widget.''<br>
How to utilize Jovie text-to-speech service in your application.
 
</translate>
;[[Development/Tutorials/Collaboration/HotNewStuff/Upload|Get Hot New Stuff 3 - Upload]]  
=== D-Bus ===
:''How to add an upload dialog to your application.''<br>
 
Old links for KNS2 and KNS1 content:<br>
 
;[[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''
;[[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.''
 
;[[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;.
 
== Goya ==
; [[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.''
 
; [[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.''
 
== Other programming languages ==
 
=== Python ===
 
;[http://www.learningpython.com/2008/09/20/an-introduction-to-pyqt/ An Introduction to PyQt]
:''Starting off''
 
;[http://lateral.netmanagers.com.ar/stories/BBS47.html PyQt by Example]
:''Another introduction to PyQt''
 
;[[Development/Languages/Python/PyKDE_WebKit_Tutorial|PyKDE WebKit Tutorial]]
:''A simple web browser application in PyKDE''
 
;[[Development/Tutorials/Python introduction to signals and slots|101 Introduction to signals and slots]]
:''A simple introduction to Qt's signal and slot architecture.''
 
;[[Development/Languages/Python/PyKDE_DBus_Tutorial|PyKDE DBus Tutorial]]
:''An introduction to DBus communication using PyKDE''
 
;[[Development/Languages/Python/PyKDE_Knotify_Tutorial|PyKDE KNotify Tutorial]]
:''An introduction to Knotify (Notifications and KJobs) using PyKDE''
 
=== Ruby ===
 
;[http://developer.kde.org/language-bindings/ruby/kde3tutorial/index.html KDE Ruby Korundum tutorial]
:''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]]
:''Nokia's fabulous introductory tutorial to Qt, translated to Ruby.''
 
;[[Development/Tutorials/Plasma/RubyApplet|Creating a Plasma Widget in Ruby]]
:''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]]
:''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]]
:''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 ===
 
;[[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.''
 
== Graphics Programming ==
 
;[[Development/Tutorials/Graphics/Performance|QPainter Perfomance]]
:''Hints on avoiding common mistakes leading to poor performance when using QPainter''
 
== Using the KDE Games Libraries ==
;[[Development/Tutorials/Games/KStandardGameAction| KStandardGameAction]]
:''Using libkdegames to make your game fit the kdegames standard''
;[[Development/Tutorials/Games/Highscores| Highscores]]
:''Implementing a simple highscore table into your game''
;[[Development/Tutorials/Games/Theme Selector| Theme Selector]]
:''Using the libkdegames theme selection dialog''
;[[Development/Tutorials/Games/Palapeli Patterns| Palapeli Slicers]]
:''Creating a slicer plugin for Palapeli''
 
=== KGLEngine ===
;[[Development/Tutorials/Games/kglengine/kglengine-simpleBox| installation and your first KGLItem]]
:''start your first kglengine application''
;[[Development/Tutorials/Games/KGLEngine2d| kglpong]]
:''Now use our knowledge to make a pong''
 
=== KALEngine ===
;[[Development/Tutorials/Games/KALEngine| Play hello word sound]]
:''Using KALEngine for games sound development using openAL''
;[[Development/Tutorials/Games/KALEngine-music| Play music]]
:''Using KALEngine to play music in a stream''
 
== Using the KDE PIM Libraries ==
;[[Development/Tutorials/PIM/ical| iCalendar functionality]]
:''Using kcal to manage iCalendar files''


== Other tutorials ==
; [[Special:myLanguage/Development/Tutorials/Porting_to_D-Bus|<translate><!--T:99-->
Porting from DCOP to D-Bus</translate>]]
:<translate> <!--T:100-->
Port your applications from DCOP to D-Bus with this handy guide.
</translate>


=== 2D Plotting (KPlotWidget) ===
=== Personal Information Management (Akonadi) ===
;[[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).''


=== Spelling and Grammar Checking (Sonnet) ===
;[[Special:myLanguage/Development/AkonadiPorting|<translate><!--T:173-->
;[[Development/Tutorials/Sonnet/SonnetTutorial|Adding spell-checking or grammar-checking to KDE applications]]
Porting Applications which use KResource API</translate>]]
:''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.''
:<translate><!--T:174-->
Applications using KDE's now deprecated KResource APIs, e.g. KABC or KCal, need to be ported to use their Akonadi equivalents


=== Pixmap cache (KPixmapCache) ===
=== Get Hot New Stuff  === <!--T:203-->
;[[Development/Tutorials/KPixmapCache|Using the KDE pixmap cache]]
Old links for KNS2 and KNS1 content:<br />
:''This tutorial shows how to use KPixmapCache to cache e.g. pixmaps generated from SVGs or some data.''
</translate>
;[[Special:myLanguage/Development/Tutorials/K Hot New Stuff2|<translate><!--T:204-->
Introduction to Get Hot New Stuff 2</translate>]]  
:<translate><!--T:205-->
A short tutorial about how to use KHotNewStuff2 in your application. Deprecated, use version 3 </translate>
;[[Special:myLanguage/Development/Tutorials/Introduction to Get Hot New Stuff|<translate><!--T:206-->
Introduction to Get Hot New Stuff</translate>]]
:<translate><!--T:207-->
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.</translate>
;[[Special:myLanguage/Development/Tutorials/KNewStuffSecure|<translate><!--T:208-->
KNewStuff Secure</translate>]] ([http://developer.kde.org/documentation/tutorials/knewstuffsecure/index.html <translate><!--T:209-->
Original Link</translate>])
:<translate><!--T:210-->
Tutorial showing how to share resources in a secured way (KDE 3.4 and later). By András Mantia &lt;[email protected]&gt;.


=== Using MarbleWidget (Marble) ===
=== Goya === <!--T:211-->
;[[Development/Tutorials/MarbleWidget|Using MarbleWidget]]
</translate>
:''This short tutorial describes how to use the MarbleWidget in your project''
; [[Special:myLanguage/Development/Tutorials/Introduction to Goya usage|<translate><!--T:212-->
Introduction to Goya usage</translate>]]
:<translate><!--T:213-->
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.</translate>
; [[Special:myLanguage/Development/Tutorials/Introduction to Goya usage 2|<translate><!--T:214-->
Introduction to Goya usage (part 2)</translate>]]
:<translate><!--T:215-->
The second part of the tutorial, with a slightly more complex example than the first part.
</translate>


=== Using local SCM for KDE development ===
<translate>
;[[Development/Tutorials/Git|Using Git to develop for KDE]]
=== Using the KDE PIM Libraries === <!--T:322-->
:''This tutorial shows how to use Git to develop for KDE''
</translate>


=== Kwin effect tutorial (blog) ===
;[[Special:myLanguage/Development/Tutorials/PIM/ical|<translate> <!--T:259-->
;[http://blog.martin-graesslin.com/blog/?p=258 blog by Martin Graesslin]
iCalendar functionality</translate>]]
:''This tutorial guides you through the development of a simple KWin effect''
:<translate><!--T:260-->
Using kcal to manage iCalendar files</translate>
<translate>


=== Implementing KSysGuard sensors and adding them ===
=== Pixmap cache (KPixmapCache) === <!--T:309-->
;[[Development/Tutorials/Sensors]]
</translate>
:''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/KPixmapCache|<translate><!--T:269-->
;[[Development/Tutorials/PortToKStatusNotifierItem]]
Using the KDE pixmap cache</translate>]]
:''This tutorials shows how to port an application using KSystemTrayIcon to KStatusNotifierItem''
:<translate>
<!--T:316-->
This tutorial shows how to use KPixmapCache to cache e.g. pixmaps generated from SVGs or some data.


=== Using the KDE Wallet API for safe storage ===
=== Porting an application from KSystemTrayIcon to KStatusNotifierItem === <!--T:282-->
;[[Development/Tutorials/KWallet]]
</translate>
:"Brief introduction to the KWallet API which can be used for storing all kinds of sensitive information."


== KDE2 and KDE3 Materials ==
;[[Special:myLanguage/Development/Tutorials/PortToKStatusNotifierItem|<translate><!--T:283-->
Porting from KSystemTrayIcon to KStatusNotifierItem</translate>]]
:<translate><!--T:284-->
This tutorials shows how to port an application using KSystemTrayIcon to KStatusNotifierItem


;[[Development/Tutorials/KDE3|KDE3 Tutorials]]
===How to edit a wiki with Libmediawiki === <!--T:288-->
:''These tutorials cover topics related to KDE3.''
</translate>
;[[Special:myLanguage/Development/Tutorials/Libmediawiki|<translate><!--T:289-->
Libmediawiki</translate>]]
:<translate><!--T:290-->
This tutorial present how to edit a wiki with Libmediawiki.


;[[Development/Tutorials/KDE2|KDE2 Tutorials]]
=== KDE2 and KDE3 Materials === <!--T:291-->
:''These tutorials cover topics related to KDE2.''
</translate>
;[[Special:myLanguage/Development/Tutorials/KDE3|<translate><!--T:295-->
KDE3 Tutorials</translate>]]
:<translate><!--T:296-->
These tutorials cover topics related to KDE3.</translate>
;[[Special:myLanguage/Development/Tutorials/KDE2|<translate><!--T:297-->
KDE2 Tutorials</translate>]]
:<translate><!--T:298-->
These tutorials cover topics related to KDE2.


<!--T:299-->
[[Category:KDE4]]
[[Category:KDE4]]
[[Category:Tutorial]]
</translate>

Latest revision as of 21:50, 18 July 2023

These tutorials were updated and moved to https://develop.kde.org/docs/


Below is the old version of this wiki page.



Here is a list of currently available tutorials for developing KDE Applications or KDE Plasma, or using KDE Frameworks to develop a 3rd-party application.

Basics of how to develop with KDE Frameworks

These tutorials were moved to Getting Started with KXmlGui. Not yet moved pages:

Common Programming Mistakes
Various common mistakes made while developing Qt and KDE applications and how to avoid them.

Integrating with Workspaces

These tutorials were moved to Features. Not yet moved pages:

Icons
Deliver your application with icons that are automatically installed to the right places. Based on the Kaction Tutorial.

Managing Configuration Data With KConfig

These tutorials were moved to Configuration. Not yet moved pages:

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.
Dealing with Language Changes
This tutorial covers dealing with changing languages: How to add the function to change the language and then dynamically update the user interface when language has been changed.
Understanding How Messages Appear to Translators
An introduction to what context information is extracted (and what isn't) from source code for translators to see.

Application Automation and Scripting

D-Bus

These tutorials were moved to D-Bus. Not yet moved pages:

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 marshaling 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.


Dolphin

These tutorials were moved to Dolphin.

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.

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

These tutorials were moved to KWin Scripting Tutorial. Not yet moved pages:

QML Window Switcher Layouts
This tutorial documents the new QML layouts for the KWin Window Switcher

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.
KCM HowTo
KCM are plugins which are loaded by System Settings to display configuration elements. They can also be used within an application.

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)

These tutorials were moved to KAuth. Not yet moved pages:

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
Introduction to Phonon tells how to compile and run the code. If you like to work in Python, try this version of the same tutorial
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 5

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

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

Creating a class template
Instructions for creating a class template, which can be used to quickly generate classes from KDevelop.
Creating a project template
Instructions for creating a project template, which can be used for starting new project with 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 whether 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.

Other programming languages

Python (PyQt4)

Note
The tutorials below apply to an older version of Qt only. While there are stable Python bindings available for Qt 5, bindings for KDE Frameworks 5 are still under development.
An Introduction to PyQt
Starting off with an introduction to PyQt4
Using PyKDE4
Introduction to PyKDE4
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

Note
The tutorials below apply to an older version of Qt only. There are currently no Ruby bindings for Qt 5 and KDE Frameworks 5 available.
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

This tutorial was moved to Shell Scripting with KDE Dialogs.

Graphics Programming

QPainter Perfomance
Hints on avoiding common mistakes leading to poor performance when using QPainter
HiDPI Support
How to render sharp GUI for HiDPI display
Migrate Qt Quick Controls 1
Qt Quick Controls 1 is not supported so please follow the guide to upgrade to Qt Quick Controls 2

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

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).
Physical Simulation
How to perform a physical simulation: animation and diagram

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.

Using the KDE Wallet API for safe storage

KWallet
"Brief introduction to the KWallet API which can be used for storing all kinds of sensitive information."

Deprecated Material

Warning
Tutorials in this section are outdated and are no longer relevant to the current state of KDE software. They are being retained here for historical purposes only. Please do not use them.


Porting Your Application to KDE4
Help Porting Applications from Qt3/KDE3 to Qt4/KDE4


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.

D-Bus

Porting from DCOP to D-Bus
Port your applications from DCOP to D-Bus with this handy guide.

Personal Information Management (Akonadi)

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

Get Hot New Stuff

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.

Using the KDE PIM Libraries

iCalendar functionality
Using kcal to manage iCalendar files

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.

Porting an application from KSystemTrayIcon to KStatusNotifierItem

Porting from KSystemTrayIcon to KStatusNotifierItem
This tutorials shows how to port an application using KSystemTrayIcon to KStatusNotifierItem

How to edit a wiki with Libmediawiki

Libmediawiki
This tutorial present how to edit a wiki with Libmediawiki.

KDE2 and KDE3 Materials

KDE3 Tutorials
These tutorials cover topics related to KDE3.
KDE2 Tutorials
These tutorials cover topics related to KDE2.