plugins/calendar plugins/kolab_addressbook plugins/tasklist
Thomas Brüderli
bruederli at kolabsys.com
Wed Feb 5 16:12:21 CET 2014
plugins/calendar/helpdocs/en_US/_static/larry/calendar-acl.png |binary
plugins/calendar/helpdocs/en_US/manage.rst | 2
plugins/kolab_addressbook/helpdocs/en_US/_static/_skin | 1
plugins/kolab_addressbook/helpdocs/en_US/_static/larry/abook-menu.png |binary
plugins/kolab_addressbook/helpdocs/en_US/addressbook.rst | 39 ++
plugins/kolab_addressbook/kolab_addressbook.php | 2
plugins/tasklist/helpdocs/en_US/_static/_skin | 1
plugins/tasklist/helpdocs/en_US/_static/larry/quickview.png |binary
plugins/tasklist/helpdocs/en_US/_static/larry/subtask-menu.png |binary
plugins/tasklist/helpdocs/en_US/_static/larry/tags-autocomplete.png |binary
plugins/tasklist/helpdocs/en_US/_static/larry/tasklist-items.png |binary
plugins/tasklist/helpdocs/en_US/filterstags.rst | 9
plugins/tasklist/helpdocs/en_US/index.rst | 1
plugins/tasklist/helpdocs/en_US/manage.rst | 135 +++++++++-
plugins/tasklist/helpdocs/en_US/overview.rst | 84 +++++-
15 files changed, 248 insertions(+), 26 deletions(-)
New commits:
commit b987fb2130178860b53ec052fb14ffc403d121e6
Author: Thomas Bruederli <thomas at roundcube.net>
Date: Wed Feb 5 16:12:13 2014 +0100
More user guide for calendar, tasklist and address book
diff --git a/plugins/calendar/helpdocs/en_US/_static/larry/calendar-acl.png b/plugins/calendar/helpdocs/en_US/_static/larry/calendar-acl.png
index 0d0b251..753644f 100644
Binary files a/plugins/calendar/helpdocs/en_US/_static/larry/calendar-acl.png and b/plugins/calendar/helpdocs/en_US/_static/larry/calendar-acl.png differ
diff --git a/plugins/calendar/helpdocs/en_US/manage.rst b/plugins/calendar/helpdocs/en_US/manage.rst
index b86cdd3..6f63c8a 100644
--- a/plugins/calendar/helpdocs/en_US/manage.rst
+++ b/plugins/calendar/helpdocs/en_US/manage.rst
@@ -84,6 +84,8 @@ first select a file from your local disk and click *Upload* in order to attach i
Even switching back and forth the tabs will not yet save the data.
+.. index:: Move, Drag & Drop
+
Moving and Resizing with the Mouse
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/plugins/kolab_addressbook/helpdocs/en_US/_static/_skin b/plugins/kolab_addressbook/helpdocs/en_US/_static/_skin
new file mode 120000
index 0000000..0137289
--- /dev/null
+++ b/plugins/kolab_addressbook/helpdocs/en_US/_static/_skin
@@ -0,0 +1 @@
+larry
\ No newline at end of file
diff --git a/plugins/kolab_addressbook/helpdocs/en_US/_static/larry/abook-menu.png b/plugins/kolab_addressbook/helpdocs/en_US/_static/larry/abook-menu.png
new file mode 100644
index 0000000..7c26c6c
Binary files /dev/null and b/plugins/kolab_addressbook/helpdocs/en_US/_static/larry/abook-menu.png differ
diff --git a/plugins/kolab_addressbook/helpdocs/en_US/addressbook.rst b/plugins/kolab_addressbook/helpdocs/en_US/addressbook.rst
new file mode 100644
index 0000000..2142d65
--- /dev/null
+++ b/plugins/kolab_addressbook/helpdocs/en_US/addressbook.rst
@@ -0,0 +1,39 @@
+.. index:: Sharing
+.. _kolab-addressbook-sharing:
+
+
+Sharing Address Books
+=====================
+
+Just like calendars or regular email folders, personal address books can also be shared
+with other users in your workgroup.
+
+
+Share Contacts with others
+--------------------------
+
+.. container:: image-right
+
+ .. image:: _static/_skin/abook-menu.png
+
+ Settings for sharing is controlled through the address book properties accessible
+ through the *More actions* menu behind the gear icon the footer in the :ref:`addressbook-groups` list.
+
+ 1. Select the address book you want to share.
+ 2. Choose *Edit address book* from the actions menu.
+ 3. Switch to the *Sharing* tab in the properties form on the right.
+
+ The table displays who already has permission to see and modify the selected address book.
+ Here you can manage permissions the same way as :ref:`Sharing a Folder <settings-folder-sharing>`.
+
+
+Subscribe to Shared Address Books
+---------------------------------
+
+Address books shared by others are not showing up right away in the directories list of the web client.
+Switch to :ref:`Settings > Folders <settings-folders>` to see all resources you can access.
+There's a shortcut to this: click *Manage folders* in the actions menu behind the gear icon
+located the footer of the directory list.
+
+In order to make a shared address book appear in the address book view, locate it in the folder manager
+and check the *Subscribed* mark in the list. Only subscribed directories are visible in the address book view.
diff --git a/plugins/kolab_addressbook/kolab_addressbook.php b/plugins/kolab_addressbook/kolab_addressbook.php
index bcaf97d..4f812c2 100644
--- a/plugins/kolab_addressbook/kolab_addressbook.php
+++ b/plugins/kolab_addressbook/kolab_addressbook.php
@@ -29,7 +29,7 @@
class kolab_addressbook extends rcube_plugin
{
- public $task = 'mail|settings|addressbook|calendar';
+ public $task = 'mail|settings|addressbook|calendar|tasks';
private $sources;
private $rc;
diff --git a/plugins/tasklist/helpdocs/en_US/_static/_skin b/plugins/tasklist/helpdocs/en_US/_static/_skin
new file mode 120000
index 0000000..0137289
--- /dev/null
+++ b/plugins/tasklist/helpdocs/en_US/_static/_skin
@@ -0,0 +1 @@
+larry
\ No newline at end of file
diff --git a/plugins/tasklist/helpdocs/en_US/_static/larry/quickview.png b/plugins/tasklist/helpdocs/en_US/_static/larry/quickview.png
new file mode 100644
index 0000000..6e8372e
Binary files /dev/null and b/plugins/tasklist/helpdocs/en_US/_static/larry/quickview.png differ
diff --git a/plugins/tasklist/helpdocs/en_US/_static/larry/subtask-menu.png b/plugins/tasklist/helpdocs/en_US/_static/larry/subtask-menu.png
new file mode 100644
index 0000000..2492110
Binary files /dev/null and b/plugins/tasklist/helpdocs/en_US/_static/larry/subtask-menu.png differ
diff --git a/plugins/tasklist/helpdocs/en_US/_static/larry/tags-autocomplete.png b/plugins/tasklist/helpdocs/en_US/_static/larry/tags-autocomplete.png
new file mode 100644
index 0000000..b1e4346
Binary files /dev/null and b/plugins/tasklist/helpdocs/en_US/_static/larry/tags-autocomplete.png differ
diff --git a/plugins/tasklist/helpdocs/en_US/_static/larry/tasklist-items.png b/plugins/tasklist/helpdocs/en_US/_static/larry/tasklist-items.png
new file mode 100644
index 0000000..6f5a2c2
Binary files /dev/null and b/plugins/tasklist/helpdocs/en_US/_static/larry/tasklist-items.png differ
diff --git a/plugins/tasklist/helpdocs/en_US/filterstags.rst b/plugins/tasklist/helpdocs/en_US/filterstags.rst
deleted file mode 100644
index 342ad8d..0000000
--- a/plugins/tasklist/helpdocs/en_US/filterstags.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. index:: Filter, Tags
-.. _taskslist-tags:
-
-Filters and Tags
-================
-
-TBD.
-
-
diff --git a/plugins/tasklist/helpdocs/en_US/index.rst b/plugins/tasklist/helpdocs/en_US/index.rst
index 2ca3876..ea8770a 100644
--- a/plugins/tasklist/helpdocs/en_US/index.rst
+++ b/plugins/tasklist/helpdocs/en_US/index.rst
@@ -12,4 +12,3 @@ The *Tasks* module helps you organize your daily jobs and ToDo's and will alert
overview
manage
- filterstags
diff --git a/plugins/tasklist/helpdocs/en_US/manage.rst b/plugins/tasklist/helpdocs/en_US/manage.rst
index 0b1e15a..0ac8be0 100644
--- a/plugins/tasklist/helpdocs/en_US/manage.rst
+++ b/plugins/tasklist/helpdocs/en_US/manage.rst
@@ -3,40 +3,157 @@
Managing Tasks
==============
-TBD.
+All the described functions to manage your tasks are accessible from the main task view.
Create new Tasks
----------------
-TBD.
+**The New Task Dialog**
+ Click the *New task* button in the toolbar to get an empty dialog where you enter the
+ tasks properties like title, description, start/due dates and reminder settings.
+ Click *Save* to finally add it to the selected task list.
+**Quick Entry**
+ The text box in the centre of the toolbar area lets you add new tasks very fast by
+ simply entering a title and then press <Enter> on the keyboard. Tasks will be created
+ in the currently selected list.
+
+ Begin the quick entry with a date or time description like "Tomorrow" or "Monday at 16:00"
+ to directly assign a due date to the task.
+
+
+.. _tasklist-edit-task:
Edit Tasks
----------
-TBD.
+The Edit Dialog
+^^^^^^^^^^^^^^^
+
+When clicking a task item in list a dialog showing its details is displayed. Clicking the Edit button
+in that dialog opens the form to edit all properties of the selected task.
+
+The edit form is divided into different section which can be switched using the tabs on top of the dialog:
+
+**Summary**
+
+This general section has text fields and selectors for various properties. Hereâs a description of all the possible values:
+
+* ``Title``: The title of the task. This is what you will see in the list.
+* ``Description``: Any text that describes the task. Links and email addresses will be become clickable.
+* ``Tags``: A list of tags assigned to this task. Add one by typing to the text box and hit <Enter>.
+* ``Start``: The date/time, the task is supposed to be worked on.
+* ``Due``: The date/time this job is due. Define a time when setting a reminder for this task.
+* ``Reminder``: This will pop up with an notification at a the specified time before the task is due.
+* ``Complete``: The completeness state of a task in percent. Use the slider or enter a number.
+* ``Tasklist``: The list the task is saved in. Change it to move an event from one list to another.
+
+
+.. only:: kolab
+
+ **Attachments**
+
+ Append files and documents related to this task directly as attachments.
+ Switch to the Attachments tab to upload files to the current task or to remove them again. Adding
+ files works pretty much the same as :ref:`attaching them to email messages <mail-compose-attachments>`:
+ first select a file from your local disk and click *Upload* in order to attach it.
+
+ .. note:: Don't forget to finally save the changes by clicking *Save* in the edit dialog.
+ Switching back and forth the tabs will not yet save the data.
+
+
+.. index:: Tags
+
+Assign Tags
+^^^^^^^^^^^
+
+Tags help you organize your tasks in the list view. Open the :ref:`Edit Dialog <tasklist-edit-task>` and
+enter tags into the according text box:
+
+.. image:: _static/_skin/tags-autocomplete.png
+
+Append a tag by hitting <Enter> and continue typing to add more. While typing, a suggestion of already
+used tags will be shown. Use the arrow keys on the keyboard to select one and press <Enter> to select.
+
+Remove tags with a click on the *Remove* icon.
+
+**Datg & Drop Tags**
+
+Existing tags listed in the tags box on the left can also be assigned to tasks directly in the list view
+by simply dragging the tag from the box and drop it on a task bar.
.. index:: Due Date
-Setting Due Dates
------------------
+Set Due Dates
+^^^^^^^^^^^^^
-TBD.
+Assign due dates to your tasks to not miss your deadlines and to enable reminder notifications for them.
+The due dates with time can be entered in the :ref:`Edit Dialog <tasklist-edit-task>`. When entering the input
+field, a small calendar widget will help you to quickly select a date.
+
+Due dates can also be entered or changed directly in the list view without going to the edit dialog.
+Click the due date or the "no date" area on the right end of a task bar and select a date from the calendar widget.
+The change will be saved immediately.
.. index:: Complete
Mark Tasks as Complete
-----------------------
+^^^^^^^^^^^^^^^^^^^^^^
+
+In the :ref:`tasklist-edit-task` section we learned how to set a percentage value
+for a task's completeness. Until a task isn't fully completed, the percentage is displayed as a
+think horizontal line in the list view.
-TBD.
+In order to mark a task as complete, simply click the checkbox in the list view. The task is now
+grayed out and moved to the bottom of the list. After some time or when refreshing the list, completed
+tasks will be removed from the view. You can still find them with the *Complete* quick filter.
+Uncheck the box to bring it back to the normal list.
Organize Tasks in Groups
------------------------
-TBD.
+For bigger jobs or entire projects, tasks can be divided into subtasks and organized hierarchically
+to visualize dependencies.
+
+Create a Subtask
+^^^^^^^^^^^^^^^^
+
+.. container:: image-right
+
+ .. image:: _static/_skin/subtask-menu.png
+
+ 1. Open the options menu of a task from the arrow icon on the far right of the task bar.
+ 2. Select *Add subtask*
+ 3. Enter the subtask properties in the :ref:`Edit Dialog <tasklist-edit-task>`
+ 4. Press *Save* to insert it
+
+
+.. index:: Move, Drag & Drop
+
+Re-organize Groups
+^^^^^^^^^^^^^^^^^^
+
+Ther hierarchical nesting of tasks and subtasks can be changed at any time. Simple grab a task with the mouse
+and drop onto another one to make it a subtask. This works for entire subtrees equally well. While dragging,
+a possible drop target is highlighted when moving over it.
+
+Drop a task onto the small bar on top of the tasks list to make it a main task again.
+
+If you organize your tasks in different lists, dropping a task onto a tasklist in the box on the left
+moves it (and all child tasks) to that particular list.
+
+
+
+Delete Tasks
+------------
+Usually finished tasks are marked as complete. But there are still situations where you might want to actually
+delete a task.
+1. Open the options menu of a task from the arrow icon on the far right of the task bar.
+2. Select *Delete*.
+3. Click *Delete* again in the confirmation dialog.
diff --git a/plugins/tasklist/helpdocs/en_US/overview.rst b/plugins/tasklist/helpdocs/en_US/overview.rst
index c05bf4b..3f788ae 100644
--- a/plugins/tasklist/helpdocs/en_US/overview.rst
+++ b/plugins/tasklist/helpdocs/en_US/overview.rst
@@ -12,28 +12,100 @@ itself, the :ref:`Tags <taskslist-tags>` and the :ref:`Tasklist Selector <taskli
The Tasks List
==============
-TBD.
+The main content are lists the task items that match the current selection of active lists,
+filters and tags. The listed tasks are sorted by due date (ascending) and completed ones move to the bottom.
+
+.. container:: image-right
+
+ .. image:: _static/_skin/tasklist-items.png
+
+ Tasks can be organized hierarchically and the list appears like a tree structure.
+ A small arrow icon on the left side of a task bar indicates subordinated tasks and expands or collapses
+ the tree upon click.
+
+ Some basic editing like flagging, assigning a due date as well as completing tasks can directly be done in the list
+ by clicking the checkbox, the flag icon or the date selector.
+
+A single click anywhere else on a task bar displays all details in a dialog box. Hit <Esc> on the keyboard
+or click the close icon to hide it again.
+
+Double-clicks open the clicked task item for full detail editing.
Control the List
----------------
-TBD.
+Quick Filters
+^^^^^^^^^^^^^
+
+The selection your tasks displayed on the screen can be refined in various ways. Use the quick filters
+above the list to reduce the listed tasks according to their status or due date.
+
+.. _taskslist-tags:
+
+Tags
+^^^^
+
+The tags list on the left is another way to display a selection of tasks. Click a tag to only display tasks
+with this tag assigned. Click it again to show all. Hold down the <Shift> key on the the keyboard to select
+mutliple tags and further reduce the selection.
+
+Task Lists
+^^^^^^^^^^
+
+The checkboxes in the :ref:`tasklist-lists` box control whether tasks from the according list are
+currently displayed. Use the *Quick View* icon |quickview| in the list to quickly reduce the view to tasks from a single
+list. This can also be used when the according list isn't activated. Click it again to turn off quick view mode and
+return to regular display of active lists.
+
+.. |quickview| image:: _static/_skin/quickview.png
Searching Tasks
---------------
-TBD.
+The search box above the calendar view lets you quickly get a list of events matching the entered keyword in either
+the title or the description text. Enter the search term into the box and press <Enter> on your keyboard to start the search.
+
+After searching, you can still use the filters and tags as explained above to hide some results.
+
+Reset the search by clicking the *Reset search* icon on the right border of the search box.
.. index:: Tasklist
.. _tasklist-lists:
-Tasklists
-=========
+Task Lists
+==========
+
+Organize your tasks in various lists. All of your personal task lists as well as those
+shared by others are listed in the box in the lower left area of the screen.
+
+You can create any number of lists to store and manage all your tasks and name them individually.
+
+
+Create a Task List
+------------------
+
+1. Click the + icon in the tasklists box footer.
+2. In the dialog, give the new list a unique name.
+3. Click *Save* to create it.
+
+.. _tasklist-edit-list:
+
+Edit List Names and Settings
+----------------------------
-TBD.
+1. Select the task list to edit by clicking the name in the box.
+2. Click the gear icon in the box footer and select *Edit* from the options menu.
+3. Adjust name or reminders settings in the edit dialog.
+4. Click *Save* to finally update the list.
+Remove entire Task Lists
+------------------------
+1. Select the task list to edit by clicking the name in the box.
+2. Click the gear icon in the box footer and select *Remove* from the options menu.
+3. After a confirmation dialog, the selected list with all its tasks will be deleted.
+ Caution: This action cannot be undone!
More information about the commits
mailing list