~neon/kactivities/master : contents of README.md at revision 980

~neon/kactivities/master : (revision 980)

# KActivities

Core components for the KDE Activity concept

## Introduction

When a user is interacting with a computer, there are three main areas of
contextual information that may affect the behaviour of the system: who the user
is, where they are, and what they are doing.

*Activities* deal with the last one. An activity might be "developing a KDE
application", "studying 19th century art", "composing music" or "watching funny
videos". Each of these activites may involve multiple applications, and a single
application may be used in multiple activities (for example, most activities are
likely to involve using a web browser, but different activities will probably
involve different websites).

KActivities provides the infrastructure needed to manage a user's activites,
allowing them to switch between tasks, and for applications to update their
state to match the user's current activity. This includes a daemon, a library
for interacting with that daemon, and plugins for integration with other
frameworks.

## Usage

Most applications that wish to be activity-aware will want to use
KActivities::Consumer to keep track of the user's current activity, and
KActivities::ResourceInstance to notify the activity manager of resources the
user has accessed (this is not necessary for resources accessed via KIO, as a
plugin is provided to do that automatically).

The other classes available in the API are primarily intended for use by the
workspace to allow the user to view and manage available activities.

381.1.62 by Marco Martin add metadata files for reviewboard and p.k.o	1	# KActivities
	2
688 by David Faure Add one-line description for the framework, as required by inqlude.	3	Core components for the KDE Activity concept
	4
381.1.62 by Marco Martin add metadata files for reviewboard and p.k.o	5	## Introduction
509 by Alex Merry Flesh out README.md, and remove Mainpage.dox	6
	7	When a user is interacting with a computer, there are three main areas of
	8	contextual information that may affect the behaviour of the system: who the user
	9	is, where they are, and what they are doing.
	10
	11	Activities deal with the last one. An activity might be "developing a KDE
	12	application", "studying 19th century art", "composing music" or "watching funny
	13	videos". Each of these activites may involve multiple applications, and a single
	14	application may be used in multiple activities (for example, most activities are
	15	likely to involve using a web browser, but different activities will probably
	16	involve different websites).
	17
	18	KActivities provides the infrastructure needed to manage a user's activites,
	19	allowing them to switch between tasks, and for applications to update their
	20	state to match the user's current activity. This includes a daemon, a library
	21	for interacting with that daemon, and plugins for integration with other
	22	frameworks.
	23
	24	## Usage
	25
	26	Most applications that wish to be activity-aware will want to use
	27	KActivities::Consumer to keep track of the user's current activity, and
	28	KActivities::ResourceInstance to notify the activity manager of resources the
	29	user has accessed (this is not necessary for resources accessed via KIO, as a
	30	plugin is provided to do that automatically).
	31
	32	The other classes available in the API are primarily intended for use by the
	33	workspace to allow the user to view and manage available activities.