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