KTp/Components/Accounts KCM Creating Plugins: Difference between revisions

From KDE Community Wiki
< KTp
(Created page with '== Understanding The Account Mangler == === Overview === Each IM protocol has a different set of options it wouldn't make sense to set up a server for the bonjour protocol for ...')
 
Line 23: Line 23:
Dave - WRITE ME!
Dave - WRITE ME!


=== Why are some protocols listed twice in the Add Account List ==
=== Why are some protocols listed twice in the Add Account List ===


In telepathy lots of programs (connection managers) supply your interface to the protocol. i.e a program called "butterfly" will be the link between telepathy and MSN. However sometimes two programs are both capable of supplying a protocol, this causes it to be in the list twice.
In telepathy lots of programs (connection managers) supply your interface to the protocol. i.e a program called "butterfly" will be the link between telepathy and MSN. However sometimes two programs are both capable of supplying a protocol, this causes it to be in the list twice.

Revision as of 02:28, 7 January 2011

Understanding The Account Mangler

Overview

Each IM protocol has a different set of options it wouldn't make sense to set up a server for the bonjour protocol for example.

Each of these options has to be presented to the user, in order to do this we need to make a KDE plugin which has a different form for each, and a different validator.

Our resident genius George wrote a plugin that automatically builds a form for every type of protocol, however it has no knowledge of which fields are important or being able to come up with user friendly names for these parameters. Therefore it should only be used as a fallback mechanism.

User Friendliness

Being KDE the whole experience should be as user friendly as possible. In order to please everyone every plugin supplies two 'interfaces'.

The first is the standard configuration and contains the simple parameters. Anything mandatory should be in here (i.e username and password for MSN). There should be no advanced terminology here. It should be simple enough for anyone to use.

A plugin can optionally supply an advanced options widget. This should be used for those options that 95% of users won't want to change (i.e the server address of MSN, or "use-http-proxy"). Advanced terms such as "STUN server" can be used here. Do not duplicate items already in the standard configuration.

Either of these can be a tabbed widget containing several pages of options.

Writing a plugin

Dave - WRITE ME!

Why are some protocols listed twice in the Add Account List

In telepathy lots of programs (connection managers) supply your interface to the protocol. i.e a program called "butterfly" will be the link between telepathy and MSN. However sometimes two programs are both capable of supplying a protocol, this causes it to be in the list twice.