Toggle the table of contents

Projects/KWin: Difference between revisions

From KDE TechBase

Latest revision as of 09:38, 18 February 2022

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: #kde-kwin on irc.libera.chat
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).

Retrieved from "https://techbase.kde.org/index.php?title=Projects/KWin&oldid=106882"

@@ Line 1: / Line 1: @@
-'''This is a starting page for all relevant KWin documentation, most of which is stored in SVN or on external WWW pages.'''
+'''This is a starting page for all relevant KWin documentation, most of which is stored in git or on external WWW pages.'''
 == General information ==
 * [https://mail.kde.org/mailman/listinfo/kwin KWin mailing list]
-* [http://websvn.kde.org/*checkout*/trunk/KDE/kdebase/workspace/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).
+* IRC: #kde-kwin on irc.libera.chat
+* [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
+* [[/Build_Options|KWin Build Options]] - documentation on the available build options for KWin.
 == Developer information ==
-* [http://websvn.kde.org/*checkout*/trunk/KDE/kdebase/workspace/kwin/HACKING HACKING] -  Starting document for developers interested in helping with developing KWin, including information on the [https://mail.kde.org/mailman/listinfo/kwin KWin mailing list], KWin structure, developing tips, etc.
+* For Developer Information see the [http://community.kde.org/KWin/ KWin Section] in the KDE Community Wiki
-* [http://api.kde.org/4.x-api/kdebase-apidocs/workspace/kwin/lib/html/group__kdecoration.html libkdecoration API documentation] - API documentation for the library used for developing KWin decorations (the link points to documentation for the current development version, for other versions: [http://api.kde.org/4.0-api/kdebase-apidocs/workspace/kwin/lib/html/group__kdecoration.html 4.0] ).
+* 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://websvn.kde.org/*checkout*/trunk/KDE/kdebase/workspace/kwin/clients/PORTING clients/PORTING] - List of changes needed to port decorations from KDE3 to KDE4.
+* [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. Note that it is written for KDE3.2, but it is also usable for newer versions (see also the PORTING document above)
+* [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.
-* [http://websvn.kde.org/*checkout*/trunk/KDE/kdebase/workspace/kwin/COMPOSITE_TODO COMPOSITE_TODO ] - TODO list for compositing support in KWin.
+* [[Development/Tutorials/KWin/Scripting/API|Scripting API]] and [[Development/Tutorials/KWin/Scripting|KWin Scripting Tutorial]]
-* 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 [http://websvn.kde.org/trunk/KDE/kdebase/workspace/kwin/effects/ existing effects shipped with KWin] (especially the Howto effect in the tests/ directory as a starting point) and/or ask on the KWin mailing list if necessary.
+* [[Projects/KWin/Scripting_Update_Notes|Scripting Update Notes for version 4.9]]
 == Configuration ==
-* [http://websvn.kde.org/*checkout*/trunk/KDE/kdebase/workspace/kwin/COMPOSITE_HOWTO COMPOSITE_HOWTO ] - document on setting up support for compositing feature of KWin (X.Org configuration, driver issues, etc.).
+* [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/entry/kwin/CONFIGURING CONFIGURING ] - document on advanced KWin configuration (such as pre-configuring window-specific settings).
-* [http://websvn.kde.org/*checkout*/trunk/KDE/kdebase/workspace/kwin/CONFIGURING CONFIGURING ] - document on advanced KWin configuration (such as pre-configuring window-specific settings).