Development/Guidelines: Difference between revisions

    From KDE TechBase
    No edit summary
    No edit summary
    (16 intermediate revisions by 11 users not shown)
    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 ==
    {{movepage|http://developer.kde.org/documentation/standards/index.html}}
    ; [[Development/Guidelines/HCI/Checklists|Accessibility and Usability Checklists]]
    ; [http://developer.kde.org/documentation/design/ui/index.html Human Computer Interaction (HCI) Documents]
    : Test your application for accessibility/usability along these checklists
    : A list of very good Human Computer Interface documentation. If you do anything with the design of a GUI you should read this.


    ; [[/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.
    : 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://developer.kde.org/documentation/standards/kde/kcontrol_style/index.html KDE KControl Module Guidelines]
    ; [[Projects/Usability/HIG|KDE4 Human Interface Guidelines (HIG)]]
    : Styleguide standards for KConfig Modules used in combination with KControl.
    :  
     
    == 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).  


    == External Standards ==
    ; [http://www.w3.org/XML XML]
    ; [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.
    : 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 28: Line 29:
    : Also called NETWM or EWMH, the protocol for window manager interaction, supported by many window manager authors.
    : 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.
    : The format of .desktop files, supported by KDE.


    ; [http://www.iana.org/assignments/media-types/ MIME types]
    ; [http://www.freedesktop.org/wiki/Specifications/icon-naming-spec Icon Naming Standard]
    : 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.
    : The Freedesktop naming standard for icons, supported by KDE.
     
    ; [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. [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]
    ; [http://www.ietf.org/rfc/rfc1738.txt URL]
    Line 41: Line 45:


    ; [http://www.faqs.org/rfcs/rfc2445.html iCalendar]
    ; [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.
    : RFC 2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar). This is used to store KOrganizer and KTimeTracker (KArm in KDE < 4) data.

    Revision as of 18: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.

    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)

    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.