Difference between revisions of "Development/Tutorials/Plasma"

Jump to: navigation, search
(Plasma and Creating QML Plasmoids: rename that)
Line 1: Line 1:
 
{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}
 
{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}
  
== Plasma and Creating QML Plasmoids ==
+
== QML ==
 
Plasmoids that use the QML (aka QtQuick) declarative language to describe their user interface while having the logic of the applet, in JavaScript (QML is essentially a forge between CSS and JavaScript).  
 
Plasmoids that use the QML (aka QtQuick) declarative language to describe their user interface while having the logic of the applet, in JavaScript (QML is essentially a forge between CSS and JavaScript).  
  
Line 17: Line 17:
 
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''
 
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''
  
== Plasma Programming with C++ ==
+
== C++ ==
  
 
;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
 
;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
Line 60: Line 60:
 
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''
 
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''
  
== Plasma Programming with JavaScript ==
+
== JavaScript ==
  
 
Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.
 
Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.
Line 94: Line 94:
 
:''This guide shows you how to create a comic plugin for the comic plasmoid.''
 
:''This guide shows you how to create a comic plugin for the comic plasmoid.''
  
== Plasma Programming with Python ==
+
== Python ==
  
 
;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
 
;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
Line 114: Line 114:
 
:''Writing a simple krunner plugin in python''
 
:''Writing a simple krunner plugin in python''
  
== Plasma Programming with Ruby ==
+
== Ruby ==
 
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
 
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
 
:''Creating and running your first plasmoid in Ruby''
 
:''Creating and running your first plasmoid in Ruby''
Line 130: Line 130:
 
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''
 
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''
  
== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
+
== Web Technologies (HTML/JS/CSS) ==
 
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
 
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
 
:''Creating and running your first plasmoid in HTML''
 
:''Creating and running your first plasmoid in HTML''
  
== Plasma integration ==
+
== Plasma integration for applications ==
  
 
;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
 
;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
 
:''When your application is interested in removable hardware''
 
:''When your application is interested in removable hardware''
  
== Theme development ==
+
== Themes ==
  
 
;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
 
;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
Line 147: Line 147:
 
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''
 
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''
  
== Activity Template development ==
+
== Activity Templates ==
  
 
;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
 
;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
Line 158: Line 158:
 
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
 
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
 
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).
 
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).
 
== Presentation Slides==
 
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.
 

Revision as of 12:15, 9 November 2011


Contents

Development/Tutorials/Plasma


QML

Plasmoids that use the QML (aka QtQuick) declarative language to describe their user interface while having the logic of the applet, in JavaScript (QML is essentially a forge between CSS and JavaScript).

This is now the recommended method of creating plasmoids, where possible. The plasmoid, or applet serves as the visualization for the data which a Plasma::DataEngine contains.

It allows easily the declaring of an interface and to easily create things like ListViews with native Plasma theming. It is what Plasma is leaning the most towards, especially in the Mobile, MediaCenter and KDM shells.

Getting Started
Creating and running your first plasmoid in QML
Basic List Plasmoid
Make a QML ListView which displays basic text objects as items. Utilizes native Plasma theming and animations.
API Reference
The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.

C++

Getting Started With Plasmoids
Creating your first plasmoid in C++ with SVG background, icon and text
Getting Started With Plasmoids..Some more 
A few more starter's tips.
Writing a DataEngine
DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.
Writing a Service
Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..
Writing a PackageStructure Plugin
PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.
How to use extenders in your Plasmoid
A simple example that shows how to use extenders in a Plasmoid.
Creating Runners
Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.
Wallpaper Tutorial 1
This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.
Wallpaper Tutorial 2
This tutorial covers how to add configuration options to the wallpaper.
Creating a Plasma Shell
This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.
Creating Plasmoids
May 2010 article from Linux Magazine
Create Plasmoids using KDevelop
Article explaining the structure of Plasma and how to create a Plasmoid
Adding configuration to your plasmoid
Article explaining how to add a configuration dialog to your plasmoid.
Integrate Plasma in Applications
This tutorial shows you how to make an application dashboard based on Plasma technologies.

JavaScript

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

Plasmoids

Getting Started
Creating and running your first plasmoid in JavaScript
Getting Data
How to retreive data from a data engine
Now Playing
Slightly more advanced data engine usage: displaying what's currently playing
System Monitor
How to access systemmonitor data engine
Cheat Sheet
A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids
API Reference
The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.

Other Applications Of Javascript

Scripting Plasma Shells
The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.
Javascript Animations
How to write Animations using Javascript for use in Plasma applications
Creating Comic Plugins
This guide shows you how to create a comic plugin for the comic plasmoid.

Python

Getting Started
Creating and running your first plasmoid in Python
Using widgets
Introduction to using Plasma widgets
Using DataEngines
How to use DataEngines from a plasmoid
Writing DataEngines
How to write your own Plasma DataEngine
Writing a Plasmoid in Python
Writing a simple battery graph in python
Writing a KRunner plugin in Python
Writing a simple krunner plugin in python

Ruby

Getting Started
Creating and running your first plasmoid in Ruby
Using widgets
Introduction to using Plasma widgets
Writing a simple paste applet
A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.
Writing DataEngines
How to write your own Plasma DataEngine using Ruby
Use SVG artwork in the simplest way possible
Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.

Web Technologies (HTML/JS/CSS)

Getting Started
Creating and running your first plasmoid in HTML

Plasma integration for applications

Creating a Device Notifier action
When your application is interested in removable hardware

Themes

Creating a Plasma Theme Quickstart
A quick guide to creating your first Plasma theme
The Plasma Theme Structure In Detail
A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.

Activity Templates

Creating a Plasma Activity Template Quickstart
A quick guide to creating your first Plasma Activity Template

Resources


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