diff options
| author | Frederic Guillot <fred@kanboard.net> | 2015-06-28 18:52:01 -0400 |
|---|---|---|
| committer | Frederic Guillot <fred@kanboard.net> | 2015-06-28 18:52:01 -0400 |
| commit | e22985df50d3a0a2ac883c43749542e41e425927 (patch) | |
| tree | 784830150173ad36ad40037b9c938f09f6c77025 /docs | |
| parent | 0fa64fc9bd947e2f82f60d63d57479fa4189ef68 (diff) | |
Start to implement advanced search query language
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.markdown | 1 | ||||
| -rw-r--r-- | docs/search.markdown | 106 |
2 files changed, 107 insertions, 0 deletions
diff --git a/docs/index.markdown b/docs/index.markdown index 6eb6e6ef..77c6db2a 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -71,6 +71,7 @@ Using Kanboard ### More +- [Search syntax](search.markdown) - [Command line interface](cli.markdown) - [Syntax guide](syntax-guide.markdown) - [Frequently asked questions](faq.markdown) diff --git a/docs/search.markdown b/docs/search.markdown new file mode 100644 index 00000000..c6d5b76e --- /dev/null +++ b/docs/search.markdown @@ -0,0 +1,106 @@ +Advanced Search Syntax +====================== + +Kanboard use a simple query language for advanced search. + +Example of query +---------------- + +This example will returns all tasks assigned to me with a due date for tomorrow and that have a title that contains "my title": + +``` +assigne:me due:tomorrow my title +``` + +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 for unassigned tasks: + +``` +assignee:nobody +``` + +Query for my assigned tasks + +``` +assignee:me +``` + +Search by color +--------------- + +Attribute: **color** + +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: + +``` +due:today +``` + +Query to search tasks due tomorrow: + +``` +due:tomorrow +``` + +Query to search tasks due yesterday: + +``` +due:yesterday +``` + +Query to search tasks due with the exact date: + +``` +due:2015-06-29 +``` + +The date must use the ISO8601 format: **YYYY-MM-DD**. + +Operators supported: + +- 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** + |