[Apache Bloodhound] BloodhoundSearch modified

[Apache Bloodhound <de...@bloodhound.apache.org>]

Page "BloodhoundSearch" was changed by astaric
Diff URL: <https://issues.apache.org/bloodhound/wiki/BloodhoundSearch?action=diff&version=20>
Revision 20
Comment: Relation search specifics
Changes:
-------8<------8<------8<------8<------8<------8<------8<------8<--------
Index: BloodhoundSearch
=========================================================================
--- BloodhoundSearch (version: 19)
+++ BloodhoundSearch (version: 20)
@@ -1,9 +1,9 @@
 = Bloodhound Search =
 
-Bloodhound Search is currently in prototype phase. Read more about proposed functionality on [wiki:Proposals/BEP-0004 BEP-0004]
+Bloodhound Search is an improved version of Trac Search that uses the [https://pypi.python.org/pypi/Whoosh/ Whoosh] full text index. It will be enabled by default from version 0.6, until then, you need no manually enable it.
 
 == How to enable Bloodhound Search==
-Currently, Bloodhound Search is available only for dev configuration. Make sure that Bloodhound was installed using requirements-dev.txt:
+In versions prior to 0.6, Bloodhound Search is available only for dev configuration. Make sure that Bloodhound was installed using requirements-dev.txt:
 {{{
 pip install -r requirements-dev.txt
 }}}
@@ -18,21 +18,20 @@
 is_default = true
 }}}
 
-Run initial index rebuild using trac-admin command line tool. TODO: reindexing using admin web interface should be supported later
+Upgrading trac environment will create the index and process all of the existing resources:
 {{{
-trac-admin <path_to_trac_environment> bhsearch rebuild
+trac-admin <path_to_trac_environment> upgrade
 }}}
  
 == How to search == #search
-Click Apps menu and select Bloodhound Search item. You can search use free text search or combine search with query syntax. Please consider below a few search samples: 
+BloodhoundSearch is integrated into the quick search box on top of the page. You can search use free text search or combine search with query syntax. Please consider below a few search samples: 
 * Free text search through multiple fields e.g. "some text"
 * Combination of free text and field specific query e.g. "test status:new keyword:starter" (default operator is AND)
 * Field specific query e.g. "status:new keyword:starter" (default operator is AND)
 * Boolean queries e.g. "test OR (status:new and keyword:starter)"
 * Use meta-keywords e.g. "some text $resolved". Read more in [#meta-keywords Meta-keywords] chapter
+* Search tickets based on relations e.g. "duplicatedby:*"
 For more information on query syntax see wiki:Proposals/BEP-0004/ResourceQuery. 
-
-Currently, you can search in tickets, wiki pages and milestones (later more resources will be added). Use All | Ticket | Wiki | Milestone tabs to search entries of specific type.
 
 Bloodhound Search provides basic faceting functionality. Facets are specific for each resource type. More complex faceting can be introduced later, for example: date rages, pivot faces etc.
 
@@ -56,9 +55,19 @@
 === Milestone specific fields
  * status - possible values are "completed" or "open"
  * due - milestone due value in date-time format
- 
+
+=== Relation specific fields
+* dependson
+* dependent
+* duplicateof
+* duplicatedby
+* refersto
+* parent
+* children
+* any other custom relation type defined in trac.ini
+
 == Meta-keywords #meta-keywords
-Consider Bloodhound Search meta-keywords as shortcuts for commonly used query expressions. Meta-keyword starts with "$" character. Bloodhound Search supports the following meta-keywords:
+Meta-keywords are shortcuts for commonly used query expressions. Meta-keywords start with "$" character. Bloodhound Search supports the following meta-keywords:
  * $resolved - resolved to {{{status:(resolved OR closed)}}} query
  * $unresolved - resolved to {{{NOT $resolved}}} query
  * $ticket, $milestone, $wiki - resolved to {{{type:ticket|milestone|wiki}}} query
-------8<------8<------8<------8<------8<------8<------8<------8<--------

--
Page URL: <https://issues.apache.org/bloodhound/wiki/BloodhoundSearch>
Apache Bloodhound <https://issues.apache.org/bloodhound/>
The Apache Bloodhound issue tracker

This is an automated message. Someone added your email address to be
notified of changes on 'BloodhoundSearch' page.
If it was not you, please report to .