Project

General

Profile

RedmineSearch » History » Version 4

James Rowe, 2010-11-08 21:33
more advanced controller notes

1 1 James Rowe
h1. RedmineSearch
2
3
A part of any project management process is spent looking for existing information. Enter the Redmine search capability.
4
5
h2. Search
6
7 4 James Rowe
At the top right-hand side of Redmine is a simple search box. Type anything and press enter to search.
8 1 James Rowe
9 4 James Rowe
Searching for #{IssueID} or {IssueID} will go straight to the issue. Search parameters can be enclosed in double quotation marks.
10
11 1 James Rowe
!SimpleSearch.png!
12
13
Depending on permission settings and project membership a drop down menu option may show the current project. Simple search searches full text on the project currently displayed in that chooser.
14
15
!SearchProjects.png!
16
17
Clicking on the word *Search* will immediately take you to the advanced search and results page. Notice the project chooser has followed, and there are checkboxes to limit search to specific types of entries. The checkboxes displayed only if the module is enabled at that project level.
18
19
!AdvancedSearch.png!
20
21
h2. Search configuration
22
23 2 James Rowe
h3. Search titles only
24
25
From the advanced search box, *Search titles only* can be enabled to limit results.
26
27
h3. Search custom fields
28
29 1 James Rowe
Don't forget to set custom fields checkbox *Searchable* to true to also search these fields.
30
31
!Searchable.png!
32 2 James Rowe
33
h2. Results
34
35
Here is a sample results page from this site on "test issue".
36
37 3 James Rowe
* Many links to go to what was found.
38 2 James Rowe
* Unique text highlighting by search terms.
39
* Capability to jump to groupings of results (ie News items).
40
* Leading icons to categorize type of result (ie changeset, issue, comment)
41
42 1 James Rowe
!Results.png!
43 4 James Rowe
44
h2. Search controller
45
46
Always check the source first:
47
48
source:/trunk/app/controllers/search_controller.rb
49
50
A more advanced look at the controller explains some of the above behavior:
51
52
* Only searches the first 5 tokens of a search
53
* Tokens must be at least 2 characters long
54
* Results are returned in paginated sets of 10