Fix bug #19: Tabs ignored in HTML export
[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 - Downloading notes as HTML and reStructuredText
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 Installation
86 ============
87
88 Manual installation
89 ===================
90
91 #. SSH onto your web server
92 #. Navigate to the owncloud ``apps`` directory, often in ``/var/www/owncloud/apps``
93 #. Download the latest release from http://cweiske.de/grauphel.htm and extract it.
94    For example::
95
96      $ wget http://cweiske.de/download/grauphel/grauphel-0.5.0.tar.bz2
97      $ tar xjvf grauphel-0.5.0.tar.bz2
98      $ rm grauphel-0.5.0.tar.bz2
99
100    You do have a directory ``/var/www/owncloud/apps/grauphel`` now.
101 #. Using your browser, login as administrator into ownCloud and click
102    the "Apps" icon in the main menu ("+" icon).
103 #. Click on "Grauphel: Tomboy note server" and then on the "Enable" button.
104 #. In the main menu, click the "Tomboy notes" icon.
105
106 It may be that grauphel now shows you an error message::
107
108   PHP extension "oauth" is required
109
110 You have to install the PHP PECL oauth extension now.
111 On Debian 7, do the following::
112
113   $ apt-get install libpcre3-dev php-pear php5-dev
114   $ pecl install oauth
115   $ echo 'extension=oauth.so' > /etc/php5/conf.d/oauth.ini
116   $ /etc/init.d/apache2 restart
117
118 Reload the ownCloud page in your browser now.
119
120
121 ======
122 Author
123 ======
124 Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
125
126
127 =====
128 Links
129 =====
130 - `Homepage`__
131 - `grauphel on apps.owncloud.com`__
132 - `Source code repository`__
133 - `Github source code mirror`__
134
135 __ http://cweiske.de/grauphel.htm
136 __ http://apps.owncloud.com/content/show.php?action=content&content=166654
137 __ http://git.cweiske.de/grauphel.git/
138 __ https://github.com/cweiske/grauphel
139
140
141 =================
142 Development hints
143 =================
144 * JSON coming from Tomboy: Title is html-escaped already
145   (e.g. ``>`` is ``>``).
146   We store it that way in the database, so there is no need to escape the
147   output.
148 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
149   incremented by 1.