summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-07-18 17:22:49 -0400
committerFrederic Guillot <fred@kanboard.net>2015-07-18 17:22:49 -0400
commite7ff62f5e3c6d4e76d8391882d69d09b92919159 (patch)
treef05ebf4de2e9cb6044551e64687b8535c08d39dd /docs
parent7d9f3e7bc466e673d72c8e36078768458f36b75f (diff)
Add new search attributes: created, modified and updated
Diffstat (limited to 'docs')
-rw-r--r--docs/search.markdown96
1 files changed, 31 insertions, 65 deletions
diff --git a/docs/search.markdown b/docs/search.markdown
index 4674a07e..c269b5c1 100644
--- a/docs/search.markdown
+++ b/docs/search.markdown
@@ -31,94 +31,60 @@ Search by assignee
Attribute: **assignee**
-Query with the full name:
+- Query with the full name: `assignee:"Frederic Guillot"`
+- Query with the username: `assignee:fguillot`
+- Multiple assignee lookup: `assignee:user1 assignee:"John Doe"`
+- Query for unassigned tasks: `assignee:nobody`
+- Query for my assigned tasks: `assignee:me`
-```
-assignee:"Frederic Guillot"
-```
-
-Query with the username:
-
-```
-assignee:fguillot
-```
-
-Multiple assignee lookup:
-
-```
-assignee:user1 assignee:"John Doe"
-```
-
-Kanboard will search tasks assigned to the "user1" or "John Doe".
-
-Query for unassigned tasks:
-
-```
-assignee:nobody
-```
-
-Query for my assigned tasks
-
-```
-assignee:me
-```
-
-Note: Results will also include subtasks assignee with the status todo or in progress.
+Note: Kanboard will also search in assigned subtasks with the status todo and in progress.
Search by color
---------------
Attribute: **color**
-Query to search by color id:
-
-```
-color:blue
-```
-
-Query to search by color name:
-
-```
-color:"Deep Orange"
-```
+- Query to search by color id: `color:blue`
+- Query to search by color name: `color:"Deep Orange"`
Search by due date
------------------
Attribute: **due**
-Query to search tasks due today:
+- Search tasks due today: `due:today`
+- Search tasks due tomorrow: `due:tomorrow`
+- Search tasks due yesterday: `due:yesterday`
+- Search tasks due with the exact date: `due:2015-06-29`
-```
-due:today
-```
+The date must use the ISO8601 format: **YYYY-MM-DD**.
-Query to search tasks due tomorrow:
+All string formats supported by the `strtotime()` function are supported, by example `next Thursday`, `-2 days`, `+2 months`, `tomorrow`, etc...
-```
-due:tomorrow
-```
+Operators supported with a date:
-Query to search tasks due yesterday:
+- Greater than: **due:>2015-06-29**
+- Lower than: **due:<2015-06-29**
+- Greater than or equal: **due:>=2015-06-29**
+- Lower than or equal: **due:<=2015-06-29**
-```
-due:yesterday
-```
+Search by modification date
+---------------------------
-Query to search tasks due with the exact date:
+Attribute: **modified** or **updated**
-```
-due:2015-06-29
-```
+The date formats are the same as the due date.
-The date must use the ISO8601 format: **YYYY-MM-DD**.
+There is also a filter by recently modified tasks: `modified:recently`.
-Operators supported:
+This query will use the same value as the board highlight period configured in settings.
-- Greater than: **due:>2015-06-29**
-- Lower than: **due:<2015-06-29**
-- Greater than or equal: **due:>=2015-06-29**
-- Lower than or equal: **due:<=2015-06-29**
+Search by creation date
+-----------------------
+
+Attribute: **created**
+
+Works in the same way as the modification date queries.
Search by description
---------------------