~ubuntu-branches/ubuntu/oneiric/kdeplasma-addons/oneiric

« back to all changes in this revision

Viewing changes to runners/events/README.markdown

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2010-11-26 13:35:18 UTC
  • mto: (0.4.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 84.
  • Revision ID: james.westby@ubuntu.com-20101126133518-remqkgqjafk2a4jc
Tags: upstream-4.5.80
Import upstream version 4.5.80

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Events Runner
 
2
=============
 
3
 
 
4
This is Plasma Runner Plugin, which provides you ability to add new events or todos to your calendar from KRunner (Alt+F2). With this runner you may enter into KRunner something like following:
 
5
 
 
6
* `event Project deadline; 13.02.2010` - create new event with summary "Project deadline" for 13.02.2010;
 
7
* `todo Complete my work; tomorrow 12:30; Business` - create todo with given summary and deadline datetime with category "Business";
 
8
* `event Travel to mountains; from yesterday to 31.02.2010; Travel` - create event with given time range and category;
 
9
* `event Something; 13:30` - something at 13:30 today;
 
10
* `event Other event; yesterday`
 
11
* `event Meeting; today from 12:00 to 14:00`
 
12
* `todo Buy new phone; in 2 years`
 
13
* `todo Complete site design; in 2 days after 10:30`
 
14
* And others...
 
15
 
 
16
Besides of incident creation you may update existing incidences in some ways:
 
17
 
 
18
* `complete Buy new phone` - mark selected task as completed!
 
19
* `complete Fix localization issues; 30` - set task as 30%-completed;
 
20
* `comment Birthday party; It was cool!` - append some text to task description.
 
21
 
 
22
Features
 
23
--------
 
24
 
 
25
Now following date/time specifications are available:
 
26
 
 
27
* `today`
 
28
* `yesteday`
 
29
* `tomorrow`
 
30
* `now`
 
31
* Time format - `h:m`
 
32
* Date format - `d.M.yyyy`
 
33
* `in 2 minutes/hours [after ...]`
 
34
* `in 10 days/weeks/months/years [after ...]`
 
35
* `from ... to ...`
 
36
 
 
37
You can specify event categories as third argument like they are displayed in KOrganizer:
 
38
 
 
39
* `Business`
 
40
* `Education:Exam`
 
41
* `Travel, Holiday`
 
42
 
 
43
Installation from packages
 
44
--------------------------
 
45
 
 
46
If you are using Ubuntu Karmic you may install package *plasma-runner-events* from my PPA at https://launchpad.net/~alexey-noskov/+archive/kde
 
47
 
 
48
You can add this PPA to your system by adding `ppa:alexey-noskov/kde` to your system's Software Sources
 
49
 
 
50
This PPA can be added to your system manually by copying the lines below and adding them to your system's software sources.
 
51
 
 
52
    deb http://ppa.launchpad.net/alexey-noskov/kde/ubuntu karmic main 
 
53
    deb-src http://ppa.launchpad.net/alexey-noskov/kde/ubuntu karmic main 
 
54
 
 
55
Build instructions
 
56
------------------
 
57
 
 
58
    cd /where/your/runner/is/installed
 
59
    mkdir build
 
60
    cd build
 
61
    cmake -DCMAKE_INSTALL_PREFIX=$KDEDIRS .. 
 
62
    make 
 
63
    sudo make install
 
64
 
 
65
(your $KDEDIRS is where you install your KDE 4)
 
66
 
 
67
Restart krunner:
 
68
 
 
69
    kbuildsycoca4
 
70
    kquitapp krunner
 
71
    krunner
 
72
 
 
73
Alt-F2 to launch KRunner and in the runners list you will find events runner.
 
74
 
 
75
Copyright © 2010 Alexey Noskov, released under the GPLv3 license 
 
76
Idea by SebastianHRO, published at http://forum.kde.org/brainstorm.php#idea85167