diff options
Diffstat (limited to 'docs/search.markdown')
| -rw-r--r-- | docs/search.markdown | 117 |
1 files changed, 54 insertions, 63 deletions
diff --git a/docs/search.markdown b/docs/search.markdown index 1d254b29..c269b5c1 100644 --- a/docs/search.markdown +++ b/docs/search.markdown @@ -12,6 +12,12 @@ This example will returns all tasks assigned to me with a due date for tomorrow assigne:me due:tomorrow my title ``` +Search by task id or title +-------------------------- + +- Search by task id: `#123` or `123` +- Search by task title: anything that don't match any search attributes mentioned below + Search by status ---------------- @@ -25,92 +31,60 @@ Search by assignee Attribute: **assignee** -Query with the full name: - -``` -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 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` -Query for unassigned tasks: - -``` -assignee:nobody -``` - -Query for my assigned tasks - -``` -assignee:me -``` +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 --------------------- @@ -119,6 +93,13 @@ Attribute: **description** Example: `description:"text search"` +Search by external reference +---------------------------- + +The task reference is an external id of your task, by example a ticket number from another software. + +- Find tasks with a reference: `ref:1234` or `reference:TICKET-1234` + Search by category ------------------ @@ -144,3 +125,13 @@ Attribute: **column** - Find tasks by column name: `column:"Work in progress"` - Find tasks for several columns: `column:"Backlog" column:ready` + +Search by swimlane +------------------ + +Attribute: **swimlane** + +- Find tasks by swimlane: `swimlane:"Version 42"` +- Find tasks in the default swimlane: `swimlane:default` +- Find tasks into several swimlanes: `swimlane:"Version 1.2" swimlane:"Version 1.3"` + |