Refresh doc to use README.md and markdown
This commit is contained in:
Aurélien Gâteau
parent
774f78e773
commit
b3b95fa77d
33
Mainpage.dox
33
Mainpage.dox
@ -1,33 +0,0 @@
|
||||
/** @mainpage Plasma Runtime
|
||||
|
||||
Plasma Runtime components.
|
||||
The classes documented here are not C++ public libraries: they are intended to be used from QML, with the following imports:
|
||||
|
||||
<h3>org.kde.draganddrop</h3>
|
||||
<p>Bindings for the Qt drag and drop system, see <a href="../declarativeimports/draganddrop/html/index.html">draganddrop</a> </p>
|
||||
|
||||
<h3>org.kde.plasma.components</h3>
|
||||
<p>Graphical components for common items such as buttons, lineedits, tabbars and so on. Compatible subset of the MeeGo components used on the N9, see <a href="../declarativeimports/plasmacomponents/html/index.html">plasmacomponents</a> </p>
|
||||
|
||||
<h3>org.kde.plasma.core</h3>
|
||||
<p>Bindings for libplasma functionality, such as DataEngines and FrameSvgs, see <a href="../declarativeimports/core/html/index.html">core</a> </p>
|
||||
|
||||
<h3>org.kde.plasma.extras</h3>
|
||||
<p>Extra graphical components that extend org.kde.plasma.components but are not in the standard api, see <a href="../declarativeimports/plasmaextracomponents/html/index.html">extras</a> </p>
|
||||
|
||||
<h3>org.kde.qtextracomponents</h3>
|
||||
<p>Bindings for some functionality in Qt not included in the primitive QML components set, sich as support for QImages, QPixmaps, QIcons and mouse and wheel events with screen coordinates, see <a href="../declarativeimports/qtextracomponents/html/index.html">qtextracomponents</a></p>
|
||||
|
||||
|
||||
@authors
|
||||
- Marco Martin \<mart at kde.org\>
|
||||
- Aaron Seigo \<aseigo at kde.org\>
|
||||
|
||||
@maintainers
|
||||
|
||||
@licenses
|
||||
@gpl
|
||||
|
||||
*/
|
||||
|
||||
// DOXYGEN_SET_PROJECT_NAME = Plasma Runtime
|
||||
40
README.md
40
README.md
@ -2,21 +2,41 @@
|
||||
The plasma framework provides the foundations that can be used to build a primary user interface, from graphical to logical components.
|
||||
|
||||
## Introduction
|
||||
The plasma framework is made by a library component and a runtime component:
|
||||
* libplasma: this is a library for the business logic, it manages:
|
||||
** rendering of SVG themes
|
||||
** loading of files from a certain filesystem structure: packages
|
||||
** data access: dataengines
|
||||
** loading of the plugin structure of the workspace: containments and applets
|
||||
The plasma framework provides the following:
|
||||
- A C++ library: libplasma
|
||||
- Script engines
|
||||
- QML components
|
||||
- The `plasma-shell` executable
|
||||
|
||||
* QML script engine: given the data provided by an Applet or a Containment, it maps to loading of an actual QML representation of it
|
||||
* QML components: sets of QML components to provide a widget set, and to access to libplasma components, such as SVG themes and dataengines.
|
||||
* Runtime environment: the plasma-shell executable. The runtime that will load the actual workspace, it's completely controlled by QML, by itself doesn't have any UI.
|
||||
## libplasma
|
||||
This C++ library provides:
|
||||
- rendering of SVG themes
|
||||
- loading of files from a certain filesystem structure: packages
|
||||
- data access through data engines
|
||||
- loading of the plugin structure of the workspace: containments and applets
|
||||
|
||||
See @ref libplasma.
|
||||
|
||||
## Script engines
|
||||
Provides support to create applets or containments in various scripting languages.
|
||||
|
||||
## QML components
|
||||
### org.kde.plasma.core
|
||||
|
||||
Bindings for libplasma functionality, such as DataEngine and FrameSvg, see @ref core.
|
||||
|
||||
### org.kde.plasma.components
|
||||
Graphical components for common items such as buttons, lineedits, tabbars and so on. Compatible subset of the MeeGo components used on the N9, see @ref plasmacomponents.
|
||||
|
||||
### org.kde.plasma.extras
|
||||
Extra graphical components that extend org.kde.plasma.components but are not in the standard api, see @ref plasmaextracomponents.
|
||||
|
||||
## plasma-shell
|
||||
The `plasma-shell` executable loads the actual workspace. It is completely controlled by QML and does not itself provide any user interface.
|
||||
|
||||
## Links
|
||||
|
||||
- Wiki: <http://community.kde.org/Plasma#Plasma_Workspaces_2>
|
||||
- Mailing list: <https://mail.kde.org/mailman/listinfo/plasma-devel>
|
||||
- IRC channel: #kde-devel on Freenode
|
||||
- IRC channel: #plasma on Freenode
|
||||
- Git repository: <https://projects.kde.org/projects/playground/libs/plasma-framework/repository>
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
/** @mainpage Plasma Core
|
||||
/** @page core Plasma Core
|
||||
|
||||
<h2>import org.kde.plasma.core</h2>
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
/** @mainpage Plasma Components
|
||||
/** @page plasmacomponents Plasma Components
|
||||
|
||||
<h2>import org.kde.plasma.components</h2>
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
/** @mainpage Plasma Extra Components
|
||||
/** @page plasmaextracomponents Plasma Extra Components
|
||||
|
||||
<h2>import org.kde.plasma.extras</h2>
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
/** @mainpage Plasma libraries
|
||||
/** @page libplasma libplasma
|
||||
|
||||
libplasma is the core of the Plasma desktop. It provides a framework of graphical
|
||||
widgets (Plasma::Applet) that can be organised into managed groupings
|
||||
|
||||
Loading…
Reference in New Issue
Block a user