Development/Guidelines: Difference between revisions

From KDE TechBase
No edit summary
 
m (format)
Line 1: Line 1:
__TOC__
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==
 
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 [http://developer.kde.org/policies/ Policies] section also contains standards-like documents that relate to developer activity.
== KDE Standards ==
===KDE Standards===
; [http://developer.kde.org/documentation/design/ui/index.html Human Computer Interaction (HCI) Documents]
* [http://developer.kde.org/documentation/design/ui/index.html HCI docs]
: A list of very good Human Computer Interface documentation. If you do anything with the design of a GUI you should read this.
A list of very good Human Computer Interface documentation. If you do anything with the design of a GUI you should read this.
 
* [http://developer.kde.org/documentation/standards/kde/style/basics/index.html KDE User Interface Guidelines]
; [http://developer.kde.org/documentation/standards/kde/style/basics/index.html KDE User Interface Guidelines]
The KDE User Interface Guidelines.
: The KDE User Interface Guidelines.
* [http://developer.kde.org/documentation/standards/kde/kcontrol_style/index.html KDE KControl Module Guidelines]
 
Styleguide standards for KConfig Modules used in combination with KControl.
; [http://developer.kde.org/documentation/standards/kde/kcontrol_style/index.html KDE KControl Module Guidelines]
===External Standards===
: Styleguide standards for KConfig Modules used in combination with KControl.
* [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.
== External Standards ==
* [http://www.w3.org/DOM/ DOM]
; [http://www.w3.org/XML XML]
The Document Object Model as defined by the W3C. Qt's QDom*classes are modeled after this.
: 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.
* [http://www.newplanetsoftware.com/xdnd/ XDND]
 
The specification for the inter-application drag and drop protocol used by Qt and Gtk. Meanwhile, several other applications use it.
; [http://www.w3.org/DOM/ DOM]
* [http://www.freedesktop.org/wiki/Standards_2fwm_2dspec Extended Window Manager Hint Standard]
: The Document Object Model as defined by the W3C. Qt's QDom*classes are modeled after this.
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://www.newplanetsoftware.com/xdnd/ XDND]
The format of .desktop files, supported by KDE and GNOME.
: The specification for the inter-application drag and drop protocol used by Qt and Gtk. Meanwhile, several other applications use it.
* [ftp://ftp.isi.edu/in-notes/iana/assignments/media-types/ 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.
; [http://www.freedesktop.org/wiki/Standards_2fwm_2dspec Extended Window Manager Hint Standard]
* [http://www.ietf.org/rfc/rfc1738.txt URL]
: Also called NETWM or EWMH, the protocol for window manager interaction, supported by many window manager authors.
Uniform resource locators, defined by RFC 1738.
 
* [ftp://ftp.x.org/pub/R6.4/xc/doc/hardcopy/SM SM]
; [http://www.freedesktop.org/wiki/Standards_2fdesktop_2dentry_2dspec Desktop Entry Standard]
The X11R6.4 session management protocol. This is the backend protocol for KMainWindow's high-level session management features.
: The format of .desktop files, supported by KDE and GNOME.
* [http://www.faqs.org/rfcs/rfc2445.html iCalendar]
 
RFC 2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar). This is used to store KOrganizer and KArm data.
; [ftp://ftp.isi.edu/in-notes/iana/assignments/media-types/ 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.
 
; [http://www.ietf.org/rfc/rfc1738.txt URL]
: Uniform resource locators, defined by RFC 1738.
 
; [ftp://ftp.x.org/pub/R6.4/xc/doc/hardcopy/SM SM]
: The X11R6.4 session management protocol. This is the backend protocol for KMainWindow's high-level session management features.
 
; [http://www.faqs.org/rfcs/rfc2445.html iCalendar]
: RFC 2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar). This is used to store KOrganizer and KArm data.

Revision as of 21:24, 10 September 2006

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 also contains standards-like documents that relate to developer activity.

KDE Standards

Human Computer Interaction (HCI) Documents
A list of very good Human Computer Interface documentation. If you do anything with the design of a GUI you should read this.
KDE User Interface Guidelines
The KDE User Interface Guidelines.
KDE KControl Module Guidelines
Styleguide standards for KConfig Modules used in combination with KControl.

External Standards

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 Standard
The format of .desktop files, supported by KDE and GNOME.
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 KArm data.