Projects/KWin: Difference between revisions
< Projects
Mgraesslin (talk | contribs) (SVN -> git) |
|||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
'''This is a starting page for all relevant KWin documentation, most of which is stored in | |||
'''This is a starting page for all relevant KWin documentation, most of which is stored in git or on external WWW pages.''' | |||
== General information == | == General information == | ||
| Line 10: | Line 10: | ||
* [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/entry/kwin/COMPLIANCE COMPLIANCE] - a document on KWin's compliance to the window manager specifications [http://tronche.com/gui/x/icccm/ ICCCM] and [http://www.freedesktop.org/wiki/Specifications/wm-spec EWMH] (also known as NETWM). | * [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/entry/kwin/COMPLIANCE COMPLIANCE] - a document on KWin's compliance to the window manager specifications [http://tronche.com/gui/x/icccm/ ICCCM] and [http://www.freedesktop.org/wiki/Specifications/wm-spec EWMH] (also known as NETWM). | ||
* [[/4.0-release-notes|KDE4.0 release notes]] - information about changes and new features in KWin in KDE4.0 | * [[/4.0-release-notes|KDE4.0 release notes]] - information about changes and new features in KWin in KDE4.0 | ||
* [[/Build_Options|KWin Build Options]] - documentation on the available build options for KWin. | |||
== Developer information == | == Developer information == | ||
* For Developer Information see the [http://community.kde.org/KWin/ KWin Section] in the KDE Community Wiki | * For Developer Information see the [http://community.kde.org/KWin/ KWin Section] in the KDE Community Wiki | ||
* | * http://api.kde.org/4.x-api/kde-workspace-apidocs/kwin/libkdecorations/html/index.html libkdecoration API documentation] - API documentation for the library used for developing KWin decorations (the link points to documentation for the current development version). | ||
* [http://www.usermode.org/docs/kwintheme.html KWin decorations HOWTO] - tutorial on writing KWin decorations. Based on KDE3.2 and as such slightly outdated, but it is still usable for newer versions. Note that current decorations should use KCommonDecoration class instead of KDecoration directly like this tutorial does. | * [http://www.usermode.org/docs/kwintheme.html KWin decorations HOWTO] - tutorial on writing KWin decorations. Based on KDE3.2 and as such slightly outdated, but it is still usable for newer versions. Note that current decorations should use KCommonDecoration class instead of KDecoration directly like this tutorial does. | ||
* [http://api.kde.org/4.x-api/ | * [http://api.kde.org/4.x-api/kde-workspace-apidocs/kwin/libkwineffects/html/index.html libkwineffects API documentation ] - Documentation on API for compositing effects - currently needs to be done, developers interested in developing compositing effects for KWin are currently suggested to use source of already [https://projects.kde.org/projects/kde/kdebase/kde-workspace/repository/revisions/master/show/kwin/effects existing effects shipped with KWin] and/or ask on the KWin mailing list if necessary. NOTE: This API is currently considered unstable and subject to change. | ||
* [[Development/Tutorials/KWin/Scripting/API|Scripting API]] and [[Development/Tutorials/KWin/Scripting|KWin Scripting Tutorial]] | * [[Development/Tutorials/KWin/Scripting/API|Scripting API]] and [[Development/Tutorials/KWin/Scripting|KWin Scripting Tutorial]] | ||
* [[Projects/KWin/Scripting_Update_Notes|Scripting Update Notes for version 4.9]] | * [[Projects/KWin/Scripting_Update_Notes|Scripting Update Notes for version 4.9]] | ||
Revision as of 08:34, 7 February 2013
This is a starting page for all relevant KWin documentation, most of which is stored in git or on external WWW pages.
General information
- KWin mailing list
- IRC channel #kwin on freenode
- COMPLIANCE - a document on KWin's compliance to the window manager specifications ICCCM and EWMH (also known as NETWM).
- KDE4.0 release notes - information about changes and new features in KWin in KDE4.0
- KWin Build Options - documentation on the available build options for KWin.
Developer information
- For Developer Information see the KWin Section in the KDE Community Wiki
- http://api.kde.org/4.x-api/kde-workspace-apidocs/kwin/libkdecorations/html/index.html libkdecoration API documentation] - API documentation for the library used for developing KWin decorations (the link points to documentation for the current development version).
- KWin decorations HOWTO - tutorial on writing KWin decorations. Based on KDE3.2 and as such slightly outdated, but it is still usable for newer versions. Note that current decorations should use KCommonDecoration class instead of KDecoration directly like this tutorial does.
- libkwineffects API documentation - Documentation on API for compositing effects - currently needs to be done, developers interested in developing compositing effects for KWin are currently suggested to use source of already existing effects shipped with KWin and/or ask on the KWin mailing list if necessary. NOTE: This API is currently considered unstable and subject to change.
- Scripting API and KWin Scripting Tutorial
- Scripting Update Notes for version 4.9
Configuration
- CONFIGURING - document on advanced KWin configuration (such as pre-configuring window-specific settings).