# The &kapptemplate; Handbook

## Introduction

&kapptemplate; is an application to start development quickly using existing templates providing basic repeatedly written code and a proper structure.

&kapptemplate; offers you a few basic templates projects and also picks up Plasma and KDevelop templates if some are installed on your machine.

As default you will find:

- A QML Application template

- A &kde; 4 KPart template

- A C++ KDE Frameworks template

- A Minimal C++ KDE Frameworks template

- An Akonadi resource template

- An Akonadi serializer plugin

Answer the wizard questions on each page and generate your template.

A `README` file in each template will allow you to find out how to build the template. It will also give you links for tutorials related to the project. After the project is generated, &kapptemplate;'s job is finished and you are on your own to build it.

## Using &kapptemplate;

&kapptemplate; is a wizard. The first page of the wizard explains you that &kapptemplate; will generate a base project. Click Next to start generating your project. Cancel will stop the program and quit it. Help will display this help handbook in &khelpcenter;.

&kapptemplate; first page &kapptemplate; first page

The second page lists the available templates. On the right you can see the template preview and below the template description. After you chose your template, you are invited to enter the project name in the field at the bottom.

&kapptemplate; second page &kapptemplate; second page

On the third page, you are asked for the project version, the source folder and the author name and email. If you filled &systemsettings; tab about your personal information, it will be taken from there as default.

&kapptemplate; third page &kapptemplate; third page

The fourth and last page gives you some feedback about the project generation.

&kapptemplate; fourth page &kapptemplate; fourth page

Then click Finish to close &kapptemplate;.

## What template do you need?

### Default Templates

This chapter describes the templates so you can choose the one that is the best adapted to your needs.

#### The C++ &kde; 4 &GUI; application template

This is a &cmake; based &kde; 4 &GUI; template using KXMLGuiWindow and KConfig XT. This is a &kde; 4 standard application.

Here's a screenshot of the C++ &kde; 4 &GUI; application template C++ &kde; 4 &GUI; application template

This template demonstrates how you create &kde; menus using XMLGui and how to use KConfig XT to change settings using the Settings Configure <AppName> .

You can find some great tutorials for &kde; 4 on http://techbase.kde.org/Development/Tutorials.

#### The C++ &kde; 4 KPart application template

This is a &cmake; based &kde; 4 KPart template.

Here's a screenshot of the C++ &kde; 4 Kpart template C++ &kde; 4 Kpart template

This template inherits from XMLGuiWindow and demonstrates how to use KPart.

#### C++ &kde-frameworks; application template

A &kf5-full; &GUI; Application in C++.

C++ &kde-frameworks; C++ &kde-frameworks;

#### Minimal C++ &kde-frameworks; application template

A very basic &kf5-full; &GUI; Application in C++.

Minimal C++ &kde-frameworks; Minimal C++ &kde-frameworks;

## Credits and License

- Program copyright 1998-2003 &Kurt.Granroth;

- Program copyright 2006-2008 &Anne-Marie.Mahfouf;

- Program copyright 2008 Beat Wolf

Contributors:

- Coding help: Beat Wolf asraniel@fryx.ch

- Ruby template: Cyrille Berger cberger@cberger.net

- Ruby template: Richard Dale Richard_Dale@tipitina.demon.co.uk>

- Py&kde;4 template: Christoph Burgmer chrislb@gmx.de

Documentation copyright 2008 &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail;

&underFDL; &underGPL;
&documentation.index;