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