1
<?xml version="1.0" encoding="utf-8"?>
2
<!-- ============= Search ============-->
3
<sect2 id="xiphos-searchpane">
4
<title>Simple Searches</title>
6
To conduct a quick search within the current Bible or commentary module, the Search Bar in the Sidebar should usually be adequate. Click either
7
in the menu bar <guimenuitem>Edit->Search</guimenuitem> or in the Sidebar <guimenuitem>Modules->Search</guimenuitem> to access it.
11
<title>The Search Bar</title>
14
<imageobject><imagedata fileref="figures/interface_searchpane.png" format="PNG"/>
16
<!-- EPS versions of the figures are not required at the moment. -->
19
<imagedata fileref="figures/interface_searchpane.eps" format="EPS"/>
23
<phrase>The Search Bar</phrase>
31
The <interface>Search Dialog</interface> consists of the following parts:
41
Search Module Selector
51
Search Options Checkbox
65
<sect3 id="xiphos-search-key">
66
<title>Search Key Entry Box</title>
67
<para>Allows entry of the key for which you would like to search. The
68
search key can be a word, part of a word, several words, a phrase, or
69
a regular expression depending on the type of search selected. When
70
the search key is entered and all other selections in the search dialog
71
are complete, click the <guibutton>Find</guibutton> button to begin
75
This search uses the optimized search method (see next section) if
76
the module has previously been indexed, and will use AND semantics by default
77
(verses must contain all words you entered).
81
<sect3 id="xiphos-search-modselect">
82
<title>Search Module Selector</title>
83
<para>Allows selection of which modules you would like to search.
84
Select <guibutton>Bible</guibutton> to search Bible versions or
85
<guibutton>Commentary</guibutton> to search commentaries. Only
86
the currently active module will be searched.</para>
89
<sect3 id="xiphos-search-typeselect">
90
<title>Search Type Selector</title>
91
<para>Allows selection of the type of search. There are three search
96
<term><guibutton>Multi word</guibutton></term>
97
<listitem><para>This type will match any verse that has
98
all the words in the search key, regardless of where
99
they appear in the verse.</para></listitem>
102
<term><guibutton>Regular expression</guibutton></term>
103
<listitem><para>This search uses a regular expression
104
as a search key. A regular expression is a pattern used
105
to match a string of text. A regular expression can be
106
used to find verses with words that match a particular
107
pattern. For example the regular expression
108
<userinput>[a-z]*iah </userinput> will match verses that contain
109
the words Aiah, Ahaziah, Athaliah and Amariah.</para>
110
<para>A complete discussion of regular expressions is
111
beyond the scope of this manual, but more information
112
can be found in the grep man page.</para></listitem>
115
<term><guibutton>Exact phrase</guibutton></term>
116
<listitem><para>This type will match the search key
117
exatly as entered. If the search key is <userinput>
118
it is good</userinput>, this search would match a verse
119
which contains "<emphasis>it is good</emphasis>," but
120
would not match a verse which contains "<emphasis>
121
good</emphasis>, and doeth <emphasis>it</emphasis> not,
122
to him it <emphasis>is</emphasis> sin."</para></listitem>
127
<sect3 id="xiphos-search-options">
128
<title>Search Options Checkbox</title>
129
<para>Allows selecting of search options. The only available option
130
is <guibutton>Match case</guibutton>. Check this box to make the
131
search case sensitive.</para>
134
<sect3 id="xiphos-search-scopeselect">
135
<title>Search Scope Selector</title>
136
<para>Allows defining the range within the specificed module that will
137
be searched. There are three search scopes available:</para>
140
<term><guibutton>No scope</guibutton></term>
141
<listitem><para>This button causes the search to
142
to include the entire module.</para>
146
<term><guibutton>Use bounds</guibutton></term>
147
<listitem><para>Selecting this button produces two dropdown
148
selector boxes marked <guilabel>Lower</guilabel> and
149
<guilabel>Upper</guilabel>. Select the first book
150
to search in the <guilabel>Lower</guilabel> box and
151
the last book to search in the <guilabel>Upper</guilabel>
152
box. The search will begin with the <guilabel>Lower
153
</guilabel> book and end with the <guilabel>Upper
154
</guilabel> book and include all books in between.
156
<para>Chapter and verse numbers can be entered into
157
the search bound boxes as well to further narrow the
162
<term><guibutton>Last search</guibutton></term>
163
<listitem><para>Select this button to do a new
164
search including only the verses returned as a
165
result of the last search. Use this with a new
166
search key to narrow the search further.</para>
171
<sect3 id="xiphos-search-results">
172
<title>Search Results View</title>
173
<para>This shows a list of the current search results for previewing, navigation, or saving.</para>
177
<listitem><para>To preview the search result, simply click on an individual result.
178
The entry will show in the preview pane.
183
<term>Navigation</term>
184
<listitem><para>Navigation to the search result can be done in two ways. To open the result
185
in a new tab, middle-click the mouse. To open the result in the current tab, double-click the result.
190
<term>Save Results</term>
191
<listitem><para>You may save your results as a list of bookmarks. To do this, right-click and select
192
<guilabel>Save List</guilabel>. You will be prompted to enter a name for the folder that your results
193
will be saved to. After you have saved the results, you may view them by going to your bookmarks and
194
finding the folder you just named.