Imported Upstream version 2.10+ds
[debian/jabref.git] / src / help / SearchHelp.html
1 <html xmlns="http://www.w3.org/1999/xhtml">
2 <head>
3 <link rel="stylesheet" type="text/css" href="jabref_help.css"/>
4 </head>
5
6 <body>
7
8     <h1>Searching</h1>
9
10     <h2>Keyboard shortcuts</h2>
11
12     <p><em>CTRL-F</em> opens or focuses the search interface.
13     Pressing <em>CTRL-F</em> several times toggles search mode.
14     When searching incrementally, pressing <em>CTRL-F</em> makes
15     the program search for the next occurence of the search
16     string.</p>
17
18     <p><em>CTRL-SHIFT-F</em> opens or focuses the search interface,
19     and selects incremental search. When searching incrementally,
20     <em>CTRL-SHIFT-F</em> also finds the next occurence of the
21     search string.</p>
22
23     <h2>Search modes</h2>
24    
25     <p>There are three search modes in JabRef.</p>
26     
27     <h3>Incremental search</h3>
28
29     <p>When searching incrementally, the
30     program searches immediately each time you press a letter. The
31     status line informs you about the success of the search.
32     Pressing the search shortcut keys causes the program to find
33     the next occurrence of the current search string. If no further
34     occurrences can be found, the status line will notify you about
35     this. Repeating the search again causes the search to restart
36     at the top. The search order always follows the current sorting
37     of your database. To escape an incremental search, press ESC or
38     click "Clear search".</p>
39
40     <h3>Normal search</h3>
41
42     <p>In a normal search, the program searches your
43     database for all occurences of the words in your search string,
44     once you press ENTER. Only entries containing all words will be
45     considered matches. To search for sequences of words, enclose
46     the sequences in double quotes. For instance, the query
47     <b>progress "marine aquaculture"</b> will match entries
48     containing both the word "progress" and the phrase "marine
49     aquaculture". All entries that don't match are hidden, leaving
50     for display the matching entries only (filter mode), or are
51     grayed-out (float mode). To stop displaying the search results,
52     press ESC or click "Clear search".</p>
53
54     <h3><a name="advanced" id="advanced"></a>
55         Advanced search</h3>
56
57     <p>In order to search specific fields only
58     and/or include logical operators in the search expression, a
59     special syntax is available in which these can be specified.
60     E.g. to search for entries whose author is "Miller", enter
61     (in any but incremental search mode):</p>
62
63     <p>author = miller</p>
64
65     <p>Both the field specification and the search term support
66     regular expressions. If the search term contains spaces,
67     enclose it in quotes. Do <i>not</i> use spaces in the field
68     specification! E.g. to search for entries about image
69     processing, type:</p>
70
71     <p>title|keywords = "image processing"</p>
72
73     <p>You can use "and", "or", "not", and braces as intuitively
74     expected:</p>
75
76     <p>(author = miller or title|keywords = "image processing") and
77     not author = brown</p>
78
79     <p>The "=" sign is actually a shorthand for "contains".
80     Searching for an exact match is possible using "matches" or
81     "==". Using "!=" tests if the search term is <i>not</i>
82     contained in the field (equivalent to "not ... contains ...").
83     The selection of field types to search (required, optional,
84     all) is always overruled by the field specification in the
85     search expression. To search for entries of a certain type, a
86     pseudo field called "entrytype" is available:</p>
87
88     <p>entrytype = thesis</p>
89
90     <p>This finds entries whose type (as displayed in the
91     "Entrytype" column) contains the word "thesis" (which would be
92     "phdthesis" and "mastersthesis"). Another pseudo field
93     "bibtexkey" allows to search for citation keys, e.g.</p>
94
95     <p>bibtexkey = miller2005</p>
96
97     <h2>Search settings</h2>
98
99     <p>The <em>Settings</em> button opens a
100     menu that allows to toggle case sensitivity and use of regular
101     expressions in the search, and whether search results should be
102     selected in the table and whether the search words should be
103     highlighted in the editor and the preview.</p>
104 </body>
105 </html>