[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
# Max Kanat-Alexander <mkanat@bugzilla.org>
#%]
[% PROCESS "global/field-descs.none.tmpl" %]
[% INCLUDE global/header.html.tmpl
title = "$terms.Bugzilla QuickSearch",
style_urls = ['skins/standard/page.css']
onload = 'document.forms[\'f\'].quicksearch.focus()'
%]
[% USE Bugzilla %]
<p>Type in one or more words (or pieces of words) to search for:</p>
<form name="f" action="buglist.cgi" method="get"
onsubmit="if (this.quicksearch.value == '')
{ alert('Please enter one or more search terms first.');
return false; } return true;">
<input type="text" size="40" name="quicksearch">
<input type="submit" value="Search" id="find">
</form>
<h2>The Basics</h2>
<ul class="qs_help">
<li>If you just put a word or series of words in the search box,
[%+ terms.Bugzilla %] will search the
[%+ field_descs.product FILTER html %],
[%+ field_descs.component FILTER html %],
[%+ IF use_keywords %][%+ field_descs.keywords FILTER html %],[% END %]
[%+ field_descs.alias FILTER html %],
[%+ field_descs.short_desc FILTER html %],
[%+ IF Param('usestatuswhiteboard') %][% field_descs.status_whiteboard FILTER html %],[% END %]
and [% field_descs.longdesc FILTER html %] fields for your word or words.</li>
<li>Typing just a <strong>number</strong> in the search box will take
you directly to the [% terms.bug %] with that ID. Also, just typing the
<strong>alias</strong> of [% terms.abug %] will take you to that [% terms.bug %].
</li>
<li>Adding more terms <strong>narrows down</strong> the search, it does not
expand it. (In other words, [% terms.Bugzilla %] searches for
[%+ terms.bugs %] that match <em>all</em> your criteria, not
[%+ terms.bugs %] that match <em>any</em> of your criteria.)</li>
<li>Searching is <strong>case-insensitive</strong>. So <kbd>table</kbd>,
<kbd>Table</kbd>, and <kbd>TABLE</kbd> are all the same.</li>
<li>[% terms.Bugzilla %] does not just search for the exact word you put in,
but also for any word that <strong>contains</strong> that word.
So, for example, searching for "cat" would also find [% terms.bugs %]
that contain it as part of other words—for example, [% terms.abug %]
mentioning "<strong>cat</strong>ch" or "certifi<strong>cat</strong>e". It
will not find partial words in the [% field_descs.longdesc FILTER html %]
or [% field_descs.keywords FILTER html %] fields,
though—only full words are matched, there.</li>
<li>By default, only <strong>open</strong> [% terms.bugs %] are
searched. If you want to know how to also search closed [% terms.bugs %],
see the <a href="#shortcuts">Advanced Shortcuts</a> section.</li>
<li>If you want to search <strong>specific fields</strong>, you do it like
<kbd>field:value</kbd>, where <kbd>field</kbd> is one of the
<a href="#fields">field names</a> lower down in this
document and <kbd>value</kbd> is the value you want to search for
in that field. If you put commas in the <kbd>value</kbd>, then it is
interpreted as a list of values, and [% terms.bugs %] that match
<em>any</em> of those values will be searched for.</li>
</ul>
<p>You may also want to read up on the <a href="#advanced">Advanced
Features</a>.</p>
<h2 id="fields">Fields You Can Search On</h2>
<p>You can specify any of these fields like <kbd>field:value</kbd>
in the search box, to search on them. You can also abbreviate
the field name, as long as your abbreviation matches only one field name.
So, for example, searching on <kbd>stat:VERIFIED</kbd> will find all
[%+ terms.bugs %] in the <kbd>VERIFIED</kbd> status. Some fields have
multiple names, and you can use any of those names to search for them.</p>
[% IF Bugzilla.active_custom_fields.size %]
[% SET first_field = Bugzilla.active_custom_fields.0 %]
<p>For custom fields, they can be used and abbreviated
based on the part of their name <em>after</em> the <kbd>cf_</kbd>
if you'd like, in addition to their standard name starting with
<kbd>cf_</kbd>. So for example,
<kbd>[% first_field.name FILTER html %]</kbd> can be
referred to as
<kbd>[% first_field.name.replace('^cf_') FILTER html %]</kbd>,
also. However, if this causes a conflict between the standard
[%+ terms.Bugzilla %] field names and the custom field names, the
standard field names always take precedence.</p>
[% END %]
[% SET field_table = {} %]
[% FOREACH field = quicksearch_field_names.keys %]
[% description = field_descs.$field %]
[% field_table.$description = quicksearch_field_names.${field} %]
[% END %]
<table cellspacing="0" cellpadding="0" border="0" class="qs_fields">
<thead>
<tr>
<th class="field_name">Field</th>
<th class="field_nickname">Field Name(s) For Search</th>
</tr>
</thead>
<tbody>
[% FOREACH desc = field_table.keys.sort %]
<tr>
<td class="field_name">[% desc FILTER html %]</td>
<td class="field_nickname">
[% FOREACH nickname = field_table.$desc %]
<kbd>[% nickname FILTER html %]</kbd>
[% ", " UNLESS loop.last %]
[% END %]
</tr>
[% END %]
</tbody>
</table>
<h2 id="advanced">Advanced Features</h2>
<ul class="qs_help">
<li>If you want to search for a <strong>phrase</strong> or something that
contains spaces, you can put it in quotes, like:
<kbd>"this is a phrase"</kbd>. You can also use quotes to search for
characters that would otherwise be interpreted specially by quicksearch.
For example, <kbd>"this|thing"</kbd> would search for the literal phrase
<em>this|thing</em>.</li>
<li>You can use <strong>AND</strong>, <strong>NOT</strong>,
and <strong>OR</strong> in searches.
You can also use <kbd>-</kbd> to mean "NOT", and <kbd>|</kbd> to mean "OR".
There is no special character for "AND", because by default any search
terms that are separated by a space are joined by an "AND".
Examples:
<ul>
<li>
<strong>NOT</strong>:<br>
Use <kbd><strong>-</strong><em>summary:foo</em></kbd> to exclude
[%+ terms.bugs %] with <kbd>foo</kbd> in the summary.<br>
<kbd><em>NOT summary:foo</em></kbd> would have the same effect.
</li>
<li>
<strong>AND</strong>:<br>
<kbd><em>foo bar</em></kbd> searches for [% terms.bugs %] that contains
both <kbd>foo</kbd> and <kbd>bar</kbd>.<br>
<kbd><em>foo AND bar</em></kbd> would have the same effect.
</li>
<li>
<strong>OR</strong>:<br>
<kbd><em>foo<strong>|</strong>bar</em></kbd> would search
for [% terms.bugs %] that contain <kbd>foo</kbd> OR <kbd>bar</kbd>.<br>
<kbd><em>foo OR bar</em></kbd> would have the same effect.<br>
</li>
</ul>
<p>OR has higher precedence than AND; AND is the top level operation.
For example:</p>
<p>Searching for <em><kbd>url|location bar|field -focus</kbd></em> means
(<kbd>url</kbd> OR <kbd>location</kbd>) AND (<kbd>bar</kbd> OR
<kbd>field</kbd>) AND (NOT <kbd>focus</kbd>)</p>
</li>
</ul>
<h2 id="shortcuts">Advanced Shortcuts</h2>
<p>In addition to using <a href="#fields">field names</a> to search
specific fields, there are certain characters or words that you can
use as a "shortcut" for searching certain fields:</p>
<table cellspacing="0" cellpadding="0" border="0" class="qs_fields">
<thead>
<tr>
<th class="field_name">Field</th>
<th class="field_nickname">Shortcut(s)</th>
</tr>
</thead>
<tbody>
<tr>
<td class="field_name">[% field_descs.bug_status FILTER html %]</td>
<td class="field_nickname">
Make the <strong>first word</strong> of your search the name of any
status, or even an abbreviation of any status, and [% terms.bugs %]
in that status will be searched. <strong><kbd>ALL</kbd></strong>
is a special shortcut that means "all statuses".
<strong><kbd>OPEN</kbd></strong> is a special shortcut that means
"all open statuses".
</td>
</tr>
<tr>
<td class="field_name">[% field_descs.resolution FILTER html %]</td>
<td class="field_nickname">
Make the <strong>first word</strong> of your search the name of any
resolution, or even an abbreviation of any resolution, and
[%+ terms.bugs %] with that resolution will be searched. For example,
making <kbd>FIX</kbd> the first word of your search will find all
[%+ terms.bugs %] with a resolution of <kbd>FIXED</kbd> .
</tr>
<tr>
<td class="field_name">[% field_descs.priority FILTER html %]</td>
<td class="field_nickname">"<strong>P1</strong>" (as a word anywhere in
the search) means "find [% terms.bugs %] with the highest priority.
"P2" means the second-highest priority, and so on.
<p>Searching for "<strong>P1-3</strong>" will find [% terms.bugs %] in
any of the three highest priorities, and so on.</p>
</td>
</tr>
<tr>
<td class="field_name">[% field_descs.assigned_to FILTER html %]</td>
<td class="field_nickname"><strong>@</strong><em>value</em></td>
</tr>
<tr>
<td class="field_name">[% field_descs.product FILTER html %] or
[%+ field_descs.component FILTER html %]</td>
<td class="field_nickname"><strong>:</strong><em>value</em></td>
</tr>
[% IF use_keywords %]
<tr>
<td class="field_name">[% field_descs.keywords FILTER html %]</td>
<td class="field_nickname"><strong>!</strong><em>value</em></td>
</tr>
[% END %]
<tr>
[% SET key = "flagtypes.name" %]
<td class="field_name">[% field_descs.$key FILTER html %]</td>
<td class="field_nickname">
<em>flag</em><strong>?</strong><em>requestee</em>
</td>
</tr>
<tr>
<td class="field_name">[% field_descs.longdesc FILTER html %]
or [% field_descs.short_desc FILTER html %]</td>
<td class="field_nickname">
<strong>#</strong><em>value</em>
</td>
</tr>
[% IF Param('usestatuswhiteboard') %]
<tr>
<td class="field_name">[% field_descs.short_desc FILTER html %]
or [% field_descs.status_whiteboard FILTER html %]</td>
<td class="field_nickname"><strong>[</strong><em>value</em></td>
</tr>
[% END %]
</tbody>
</table>
[% PROCESS global/footer.html.tmpl %]