From af309f737247a6bd9f46769a65e8fd906d7752df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Tue, 13 Apr 2021 14:15:25 +0200 Subject: [PATCH] Add user docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- docs/User_documentation_en.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/User_documentation_en.md b/docs/User_documentation_en.md index 84a439508..25ea8f8ee 100644 --- a/docs/User_documentation_en.md +++ b/docs/User_documentation_en.md @@ -69,3 +69,25 @@ The **sharing tab** allows you to add users or even groups to your boards. **Deleted objects** allows you to return previously deleted stacks or cards. The **Timeline** allows you to see everything that happened in your boards. Everything! +## Search + +Deck provides a global search either through the unified search in the Nextcloud header or with the inline search next to the board controls. +This search allows advanced filtering of cards across all board of the logged in user. + +For example the search `project tag:ToDo assigned:alice assigned:bob` will return all cards where the card title or description contains project **and** the tag ToDo is set **and** the user alice is assigned **and** the user bob is assigned. + +### Supported search filters + +| Filter | Operators | Query | +| ----------- | ----------------- | ------------------------------------------------------------ | +| title | `:` | text token used for a case-insentitive search on the cards title | +| description | `:` | text token used for a case-insentitive search on the cards description | +| list | `:` | text token used for a case-insentitive search on the cards list name | +| tag | `:` | text token used for a case-insentitive search on the assigned tags | +| date | `:` | 'overdue', 'today', 'week', 'month', 'none' | +| | `>` `<` `>=` `<=` | Compare the card due date to the passed date (see [supported date formats](https://www.php.net/manual/de/datetime.formats.php)) Card due dates are always considered UTC for comparison | +| assigned | `:` | id or displayname of a user or group for a search on the assigned users or groups | + +Other text tokens will be used to perform a case-insensitive search on the card title and description + +In addition wuotes can be used to pass a query with spaces, e.g. `"Exact match with spaces"` or `title:"My card"`.