diff --git a/plugins/tasklist/README b/plugins/tasklist/README index 69676edb..2bb7c3d8 100644 --- a/plugins/tasklist/README +++ b/plugins/tasklist/README @@ -1,26 +1,66 @@ A task management module for Roundcube -------------------------------------- This plugin currently supports a local database as well as a Kolab groupware server as backends for tasklists and todo items storage. + +REQUIREMENTS +------------ + +Some functions are shared with other plugins and therefore being moved to +library plugins. Thus in order to run the tasklist plugin, you also need the +following plugins installed: + +* libcalendaring [1] +* libkolab [1] + + INSTALLATION ------------ -When usigng the database driver, some initialization of the local database is -necessary: +For a manual installation of the plugin (and its dependencies), +execute the following steps. This will set it up with the database backend +driver. + +1. Get the source from git + + $ cd /tmp + $ git clone https://git.kolab.org/diffusion/RPK/roundcubemail-plugins-kolab.git + $ cd //plugins + $ cp -r /tmp/roundcubemail-plugins-kolab/plugins/tasklist . + $ cp -r /tmp/roundcubemail-plugins-kolab/plugins/libcalendaring . + $ cp -r /tmp/roundcubemail-plugins-kolab/plugins/libkolab . - cd ../../ +2. Create tasklist plugin configuration + + $ cd tasklist/ + $ cp config.inc.php.dist config.inc.php + $ edit config.inc.php + +3. Initialize the tasklist database tables + + $ cd ../../ $ bin/initdb.sh --dir=plugins/tasklist/drivers/database/SQL +4. Build css styles for the Elastic skin + + $ lessc --relative-urls -x plugins/libkolab/skins/elastic/libkolab.less > plugins/libkolab/skins/elastic/libkolab.min.css + +5. Enable the tasklist plugin + + $ edit config/config.inc.php + +Add 'tasklist' to the list of active plugins: + + $config['plugins'] = array( + (...) + 'tasklist', + ); -For some general calendar-based operations such as alarms handling, this -plugin requires the `libcalendaring` plugin, as well as libkolab plugin -for skins support, which are also part of the Kolab Roundcube Plugins -repository. Make sure these plugins are installed and configured correctly. IMPORTANT --------- This plugin doesn't work with the classic skin of Roundcube because no templates are available for that skin.