61f4559278e38b4bc399315e6696db0fd947616e
[grauphel.git] / README.rst
1 *****************************
2 grauphel - tomboy REST server
3 *****************************
4 ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
5
6 Work in progress.
7
8 __ http://owncloud.org/
9 __ https://wiki.gnome.org/Apps/Tomboy
10 __ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
11
12
13 ======
14 Status
15 ======
16
17 What works
18 ==========
19 - Note synchronization
20 - OAuth token management interface
21 - Database management interface (reset)
22 - Viewing notes
23 - Searching notes
24
25 What is missing
26 ===============
27 - Web interface to edit notes. I will probably not implement this.
28   Patches welcome :-)
29
30
31 =================
32 Supported clients
33 =================
34 * Conboy__ (Nokia N900 Maemo)
35 * Tomboy__ (Linux, Windows)
36 * Tomdroid__ (Android)
37
38 __ http://conboy.garage.maemo.org/
39 __ https://wiki.gnome.org/Apps/Tomboy
40 __ https://launchpad.net/tomdroid
41
42
43 Known working versions
44 ======================
45 grauphel 0.2.1 is known to work with:
46
47 * Tomboy 1.15.2, Linux
48 * Tomboy 1.15.1, Windows
49 * Tomdroid 0.7.5, Android 4.4.1
50
51
52 =============
53 Functionality
54 =============
55
56 Search
57 ======
58 You can use ownCloud's global search on the top right.
59
60 During search, the note's titles, tags and content are searched.
61
62 Search syntax:
63
64 ``foo``
65   Search for notes containing "foo"
66 ``foo bar``
67   Search for notes containing "foo" and "bar"
68 ``"foo bar" baz``
69   Search for notes containing "foo bar" and "baz"
70 ``foo -bar``
71   Search for notes containing "foo" but not "bar"
72
73
74 ============
75 Dependencies
76 ============
77 * PHP
78 * PHP `oauth extension`__
79
80 __ http://pecl.php.net/package/oauth
81
82
83 ======
84 Author
85 ======
86 Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
87
88
89 =====
90 Links
91 =====
92 - `Homepage`__
93 - `grauphel on apps.owncloud.com`__
94 - `Source code repository`__
95 - `Github source code mirror`__
96
97 __ http://cweiske.de/grauphel.htm
98 __ http://apps.owncloud.com/content/show.php?action=content&content=166654
99 __ http://git.cweiske.de/grauphel.git/
100 __ https://github.com/cweiske/grauphel
101
102
103 =================
104 Development hints
105 =================
106 * JSON coming from Tomboy: Title is html-escaped already
107   (e.g. ``>`` is ``>``).
108   We store it that way in the database, so there is no need to escape the
109   output.
110 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
111   incremented by 1.