Difference between revisions of "Development/Guidelines"

Latest revision as of 19:48, 12 July 2012

KDE standards are the guidelines used internally, related to UI design and consistency. The section about policies also contains standards-like documents that relate to developer activity.

[edit] Human Interface Guidelines

Accessibility and Usability Checklists: Test your application for accessibility/usability along these checklists

Community Identity Guidelines (CIG): Definitions and recommendations which help the KDE Project to establish a unique, characteristic, and appealing design.

Plasma Interface Guidelines (PIG): This document is a place to collect all the "do"s, "don't"s and "how to"s for interface elements in Plasma, particularly applets and plasmoids.

KDE4 Human Interface Guidelines (HIG)

[edit] Supported Standards

This section contains information about the industry and de facto standards used or implemented by KDE (for instance, we use the XML standard to write XML documents, and we implement the Window Manager Hint standard with KWin).

XML: The Extensible Markup language. KOffice's document formats are applications of this. It is also used as configuration file format by an increasing number of KDE programs.

DOM: The Document Object Model as defined by the W3C. Qt's QDom*classes are modeled after this.

XDND: The specification for the inter-application drag and drop protocol used by Qt and Gtk. Meanwhile, several other applications use it.

Extended Window Manager Hint Standard: Also called NETWM or EWMH, the protocol for window manager interaction, supported by many window manager authors.

Desktop Entry Specification: The format of .desktop files, supported by KDE.

Icon Naming Standard: The Freedesktop naming standard for icons, supported by KDE.

MIME types: Files types (as used to show appropriate icons in the file manager and to categorize data in drag & drop and clipboard operations) follow the convention known as MIME. Here you can find a list of registered content types.

URL: Uniform resource locators, defined by RFC 1738.

SM: The X11R6.4 session management protocol. This is the backend protocol for KMainWindow's high-level session management features.

iCalendar: RFC 2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar). This is used to store KOrganizer and KTimeTracker (KArm in KDE < 4) data.

@@ Line 1: / Line 1: @@
-This section contains information about the industry and de facto standards KDE uses. The industry standards are ones that are used or implemented by KDE (for instance, we use the XML standard to write XML documents, and we implement the Window Manager Hint standard with KWin). KDE standards are the guidelines used internally, related to UI design and consistency. The section about [[Policies|policies]] also contains standards-like documents that relate to developer activity.
+KDE standards are the guidelines used internally, related to UI design and consistency. The section about [[Policies|policies]] also contains standards-like documents that relate to developer activity.
-== KDE Standards ==
+== Human Interface Guidelines ==
-; [http://developer.kde.org/documentation/design/ui/index.html Human Computer Interaction (HCI) Documents]
+; [[Development/Guidelines/HCI/Checklists|Accessibility and Usability Checklists]]
-: A list of very good Human Computer Interface documentation. If you do anything with the design of a GUI you should read this.
+: Test your application for accessibility/usability along these checklists
-; [[/CIG|Community Identity Guidelines (CIG)]]
+; [[Development/Guidelines/CIG|Community Identity Guidelines (CIG)]]
 : Definitions and recommendations which help the KDE Project to establish a unique, characteristic, and appealing design.
-; [http://developer.kde.org/documentation/standards/kde/style/basics/index.html KDE User Interface Guidelines]
+; [[Projects/Plasma/PIG|Plasma Interface Guidelines (PIG)]]
-: The KDE User Interface Guidelines.
+: This document is a place to collect all the "do"s, "don't"s and "how to"s for interface elements in Plasma, particularly applets and plasmoids.
-; [http://wiki.openusability.org/guidelines/index.php/Main_Page The new KDE User Interface Guidelines]
+; [[Projects/Usability/HIG|KDE4 Human Interface Guidelines (HIG)]]
-: The new KDE User Interface Guidelines, being developed by the KDE usability team for KDE 4. It is advisable to use them as much as possible for development for KDE 4, and use the old ones as fallback (or ask on the usability mailinglist: kde-usability@kde.org).
+:
-; [http://developer.kde.org/documentation/standards/kde/kcontrol_style/index.html KDE KControl Module Guidelines]
+== Supported Standards ==
-: Styleguide standards for KConfig Modules used in combination with KControl.
+This section contains information about the industry and de facto standards used or implemented by KDE (for instance, we use the XML standard to write XML documents, and we implement the Window Manager Hint standard with KWin).
-== External Standards ==
 ; [http://www.w3.org/XML XML]
 : The Extensible Markup language. KOffice's document formats are applications of this. It is also used as configuration file format by an increasing number of KDE programs.
@@ Line 30: / Line 29: @@
 : Also called NETWM or EWMH, the protocol for window manager interaction, supported by many window manager authors.
-; [http://www.freedesktop.org/wiki/Standards_2fdesktop_2dentry_2dspec Desktop Entry Standard]
+; [http://standards.freedesktop.org/desktop-entry-spec/latest/index.html Desktop Entry Specification]
 : The format of .desktop files, supported by KDE.
@@ Line 36: / Line 35: @@
 : The Freedesktop naming standard for icons, supported by KDE.
-; [http://www.iana.org/assignments/media-types/ MIME types]
+; [http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec/ MIME types]
-: Files types (as used to show appropriate icons in the file manager and to categorize data in drag & drop and clipboard operations) follow the convention known as MIME. Here you can find a list of registered content types.
+: Files types (as used to show appropriate icons in the file manager and to categorize data in drag & drop and clipboard operations) follow the convention known as MIME. [http://cgit.freedesktop.org/xdg/shared-mime-info/tree/freedesktop.org.xml.in Here] you can find a list of registered content types.
 ; [http://www.ietf.org/rfc/rfc1738.txt URL]