Added search in activity stream

This commit is contained in:
Frederic Guillot
2016-04-10 15:18:20 -04:00
parent 2eadfb2291
commit 9f0166502b
54 changed files with 1066 additions and 110 deletions

View File

@@ -1,7 +1,8 @@
Advanced Search Syntax
======================
Kanboard uses a simple query language for advanced search.
Kanboard uses a simple query language for advanced search.
You can search in tasks, comments, subtasks, links but also in the activity stream.
Example of query
----------------
@@ -12,23 +13,23 @@ This example will return all tasks assigned to me with a due date for tomorrow a
assigne:me due:tomorrow my title
```
Search by task id or title
--------------------------
Global search
-------------
### Search by task id or title
- Search by task id: `#123`
- Search by task id and task title: `123`
- Search by task title: anything that doesn't match any search attributes
Search by status
----------------
### Search by status
Attribute: **status**
- Query to find open tasks: `status:open`
- Query to find closed tasks: `status:closed`
Search by assignee
------------------
### Search by assignee
Attribute: **assignee**
@@ -38,8 +39,7 @@ Attribute: **assignee**
- Query for unassigned tasks: `assignee:nobody`
- Query for my assigned tasks: `assignee:me`
Search by task creator
----------------------
### Search by task creator
Attribute: **creator**
@@ -47,23 +47,20 @@ Attribute: **creator**
- Tasks created by John Doe: `creator:"John Doe"`
- Tasks created by the user id #1: `creator:1`
Search by subtask assignee
--------------------------
### Search by subtask assignee
Attribute: **subtask:assignee**
- Example: `subtask:assignee:"John Doe"`
Search by color
---------------
### Search by color
Attribute: **color**
- Query to search by color id: `color:blue`
- Query to search by color name: `color:"Deep Orange"`
Search by the due date
----------------------
### Search by the due date
Attribute: **due**
@@ -83,8 +80,7 @@ Operators supported with a date:
- Greater than or equal: **due:>=2015-06-29**
- Lower than or equal: **due:<=2015-06-29**
Search by modification date
---------------------------
### Search by modification date
Attribute: **modified** or **updated**
@@ -94,29 +90,25 @@ There is also a filter by recently modified tasks: `modified:recently`.
This query will use the same value as the board highlight period configured in settings.
Search by creation date
-----------------------
### Search by creation date
Attribute: **created**
Works in the same way as the modification date queries.
Search by description
---------------------
### Search by description
Attribute: **description** or **desc**
Example: `description:"text search"`
Search by external reference
----------------------------
### 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
------------------
### Search by category
Attribute: **category**
@@ -124,8 +116,7 @@ Attribute: **category**
- Find all tasks that have those categories: `category:"Bug" category:"Improvements"`
- Find tasks with no category assigned: `category:none`
Search by project
-----------------
### Search by project
Attribute: **project**
@@ -133,16 +124,14 @@ Attribute: **project**
- Find tasks by project id: `project:23`
- Find tasks for several projects: `project:"My project A" project:"My project B"`
Search by columns
-----------------
### Search by columns
Attribute: **column**
- Find tasks by column name: `column:"Work in progress"`
- Find tasks for several columns: `column:"Backlog" column:ready`
Search by swim-lane
-------------------
### Search by swim-lane
Attribute: **swimlane**
@@ -150,17 +139,41 @@ Attribute: **swimlane**
- Find tasks in the default swim-lane: `swimlane:default`
- Find tasks into several swim-lanes: `swimlane:"Version 1.2" swimlane:"Version 1.3"`
Search by task link
------------------
### Search by task link
Attribute: **link**
- Find tasks by link name: `link:"is a milestone of"`
- Find tasks into several links: `link:"is a milestone of" link:"relates to"`
Search by comment
-----------------
### Search by comment
Attribute: **comment**
- Find comments that contains this title: `comment:"My comment message"`
Activity stream search
----------------------
### Search events by task title
Attribute: **title** or none (default)
- Example: `title:"My task"`
- Search by task id: `#123`
### Search events by task status
Attribute: **status**
### Search by event creator
Attribute: **creator**
### Search by event creation date
Attribute: **created**
### Search events by project
Attribute: **project**