2
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
<title>The Search Function</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s05.html" title="Module Manager"><link rel="next" href="ar01s07.html" title="The Studypad"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="search"></a>The Search Function</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-searchpane"></a>Simple Searches</h3></div></div></div><p>
4
To conduct a quick search within the current Bible or commentary module, the Search Bar in the Sidebar should usually be
5
adequate. Click either in the menu bar
6
<span class="guisubmenu">Edit</span> → <span class="guimenuitem">Search</span> or in the Sidebar
7
<span class="guisubmenu">Modules</span> → <span class="guimenuitem">Search</span> to access it. </p><div class="figure"><a name="d0e1737"></a><p class="title"><b>Figure 29. The Search Bar</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_searchpane.png" alt="The Search Bar"></div></div></div></div><br class="figure-break"><p>
8
The <span class="interface">Search Dialog</span> consists of the following parts:
9
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11
</p></li><li class="listitem"><p>
12
Search Module Selector
13
</p></li><li class="listitem"><p>
15
</p></li><li class="listitem"><p>
16
Search Options Checkbox
17
</p></li><li class="listitem"><p>
19
</p></li><li class="listitem"><p>
21
</p></li></ul></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-key"></a>Search Key Entry Box</h4></div></div></div><p>Allows entry of the key for which you would like to search. The
22
search key can be a word, part of a word, several words, a phrase, or
23
a regular expression depending on the type of search selected. When
24
the search key is entered and all other selections in the search dialog
25
are complete, click the <span class="guibutton">Find</span> button to begin
28
This search uses the optimized search method (see next section) if
29
the module has previously been indexed, and will use AND semantics by default
30
(matched verses contain all words you entered).
31
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-modselect"></a>Search Module Selector</h4></div></div></div><p>Allows selection of which modules you would like to search.
32
Select <span class="guibutton">Bible</span> to search Bible versions or
33
<span class="guibutton">Commentary</span> to search commentaries. Only
34
the currently active module will be searched.</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-typeselect"></a>Search Type Selector</h4></div></div></div><p>Allows selection of the type of search. There are three search
36
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="guibutton">Multi word</span></span></dt><dd><p>This type will match any verse that has
37
all the words in the search key, regardless of where
38
they appear in the verse. By default, "lucene" fast search
39
will be used, with fallback to the slower plain version of
40
multi-word search in the absence of an index.</p></dd><dt><span class="term"><span class="guibutton">Regular expression</span></span></dt><dd><p>This search uses a regular expression
41
as a search key. A regular expression is a pattern used
42
to match a string of text. A regular expression can be
43
used to find verses with words that match a particular
44
pattern. For example the regular expression
45
<strong class="userinput"><code>[a-z]*iah </code></strong> will match verses that contain
46
the words Aiah, Ahaziah, Athaliah and Amariah.</p><p>A complete discussion of regular expressions is
47
beyond the scope of this manual, but more information
48
can be found in the grep man page.</p></dd><dt><span class="term"><span class="guibutton">Exact phrase</span></span></dt><dd><p>This type will match the search key
49
exatly as entered. If the search key is <strong class="userinput"><code>
50
it is good</code></strong>, this search would match a verse
51
which contains "<span class="emphasis"><em>it is good</em></span>," but
52
would not match a verse which contains "<span class="emphasis"><em>
53
good</em></span>, and doeth <span class="emphasis"><em>it</em></span> not,
54
to him it <span class="emphasis"><em>is</em></span> sin."</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-options"></a>Search Options Checkbox</h4></div></div></div><p>Allows selecting of search options. The only available option
55
is <span class="guibutton">Match case</span>. Check this box to make the
56
search case sensitive.</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-scopeselect"></a>Search Scope Selector</h4></div></div></div><p>Allows defining the range within the specificed module that will
57
be searched. There are three search scopes available:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="guibutton">No scope</span></span></dt><dd><p>This button causes the search to
58
to include the entire module.</p></dd><dt><span class="term"><span class="guibutton">Use bounds</span></span></dt><dd><p>Selecting this button produces two dropdown
59
selector boxes marked <span class="guilabel">Lower</span> and
60
<span class="guilabel">Upper</span>. Select the first book
61
to search in the <span class="guilabel">Lower</span> box and
62
the last book to search in the <span class="guilabel">Upper</span>
63
box. The search will begin with the <span class="guilabel">Lower
64
</span> book and end with the <span class="guilabel">Upper
65
</span> book and include all books in between.
66
</p><p>Chapter and verse numbers can be entered into
67
the search bound boxes as well to further narrow the
68
search. </p></dd><dt><span class="term"><span class="guibutton">Last search</span></span></dt><dd><p>Select this button to do a new
69
search including only the verses returned as a
70
result of the last search. Use this with a new
71
search key to narrow the search further.</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-results"></a>Search Results View</h4></div></div></div><p>This shows a list of the current search results for previewing, navigation, or saving.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">Preview</span></dt><dd><p>To preview the search result, simply click on an individual result.
72
The entry will show in the preview pane.
73
</p></dd><dt><span class="term">Navigation</span></dt><dd><p>Navigation to the search result can be done in two ways. To open the result
74
in a new tab, middle-click the mouse. To open the result in the current tab, double-click the result.
75
</p></dd><dt><span class="term">Save Results</span></dt><dd><p>You may save your results as a list of bookmarks. To do this, right-click and select
76
<span class="guilabel">Save List</span>. You will be prompted to enter a name for the folder that your results
77
will be saved to. After you have saved the results, you may view them by going to your bookmarks and
78
finding the folder you just named.
79
</p></dd></dl></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-advanced-search"></a>Advanced Searches</h3></div></div></div><p>
80
More complicated searches might require the use of the advanced search functions, found under
81
<span class="guisubmenu">Edit</span> → <span class="guimenuitem">Advanced Search</span>.
82
</p><div class="figure"><a name="d0e1934"></a><p class="title"><b>Figure 30. The Advanced Search Dialogue</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/search_search.png" alt="The Advanced Search Dialog"></div></div></div></div><br class="figure-break"><p>
83
In <span class="guimenuitem">Advanced Search</span>, much more complex queries can be constructed, involving custom search ranges,
84
custom lists of modules over which to search, regular expression matching (see next section), and attribute-based searches
85
such as are found in footnotes or Strong's Hebrew and Greek dictionary references.
87
The default search uses "lucene" fast searching. It is an optimized search requiring a pre-built index; see the
88
<span class="guilabel">Module Manager's</span> Maintenance page for index creation. In the absence of an index, fallback to the
89
slower, plain multi-word search will be done, or can be selected deliberately here. A web search will provide several
90
references to the syntax needed to put to use the power of optimized Lucene search. A few examples follow:
92
Simple Searches: just type in the words you want to search for. To return only verses that include all of the words,
93
prefix the word with "+". So, in the KJV, you could find Psalm 23 by searching for "+Lord +shepherd +want". To search for
94
an entire phrase, surround the entire phrase with quotes, like "maketh me to lie down" (note that quotes are unnecessary
95
in all of the other examples).
97
Single Letter Wildcard: to search for "veil" or "vail", use this syntax "v?il". The "?" represents a single character
98
that could be anything. A more complex example returns both spellings for Isaiah used in the KJV. "?saia?" will return
99
results for "Isaiah" and "Esaias".
101
Multiple Letter Wildcard: to search for "prophet" or "prophesy" or "prophecy" or "prophesied", use this syntax "prophe*".
103
AND syntax: in the advanced search to return results for all of the search terms, you must put "AND" in between the terms.
104
To continue our example, if we wish to search for any occurrence of Isaiah or Esaias that also mention either prophet, or
105
prophecy, or prophesy, we can do a search like this: "?saia? AND prophe*".
107
By default, two standard search ranges are defined, for Old and New Testament; you may wish to define others for
108
e.g. "Gospels" or "Paul's Epistles". One custom module list containing only the first Bible found will be present.
109
If desired, new searches can be performed across only the current results of the previous search. Any modules may be
110
searched, including general books and even dictionaries, in any combination.
112
Note the tooltip in the screenshot above, for Attributes search. This qualifier is used to perform searches on attributes
113
that are carried with verses, instead of verse content proper, such as footnote content or Strong's Hebrew and Greek
114
references. If this button is selected, specific attribute qualifiers must be made in the Attribute Search tab, at the
115
right end of the tab set. Strong's references are identified with a leading "H" or "G" and the numeric Strong's identifier.
116
Thus, a search of KJV for Strong's Greek #140, using "G140", will return the single result of Matthew 12:18.
118
If you have indexed your modules, there is a much faster way to search for Strong's references. Enter your search preceded by
119
"lemma:", so to search for Strong's Greek #140, enter "lemma:G140". You must have selected <span class="guibutton">Optimized ("Lucene")</span>
122
Explanations of search syntax are available when either Optimized or Attribute search is selected.
124
The "Find" button also stops an in-progress search, as its tooltip indicates.
126
Results will show in the <span class="guibutton">Results</span> tab. If you wish to show Strongs, Morphology, or Footnote tags,
127
make those selections on the <span class="guibutton">Attributes Search</span> tab. Clicking once on the result will show the result
128
in the <span class="guibutton">Advanced Search</span> previewer. Hovering over Strongs, Morphology, Footnote, or Cross-reference
129
tags will show the results in the main previewer. Double-clicking a result will cause the current tab to navigate to that
130
result. This applies to search results in general books and commentaries as well, but note that the respective tab must
132
</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>
133
Changes to some of the settings (e.g. scope of search, searched modules, etc.) in Advanced Search will affect the simple search via the side pane but not vice versa.
134
</p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-search-dialog-text-regexp"></a>Search Syntax using Regular Expression</h3></div></div></div><p>
135
Regular expression searches provide a way to do simple or complex searches for strings that match a pattern or set of patterns (branches) separated by vertical bars "|". While a pattern can be built to look for a word or phrase, a simple pattern that consists of a word does not look for only that word but for any place the string of letters that make that word are found. A search for "right" will return verses that contain the word "right", but also "<span class="emphasis"><em>right</em></span>eous", "<span class="emphasis"><em>right</em></span>eousness", "un<span class="emphasis"><em>right</em></span>eous", "up<span class="emphasis"><em>right</em></span>" and even "b<span class="emphasis"><em>right</em></span>". A search for "hall not" is not a search for "hall" AND "not" but for the string "hall not" with a space between the second "l" and the "n". The search for "hall not" will find occurrences of "s<span class="emphasis"><em>hall not</em></span>".
137
The power of Regular Expressions is in the patterns (or templates) used to define a search. A pattern consists of
138
ordinary characters and some special characters that are used and interpreted by a set of rules. Special characters include
139
.\[^*$?+. Ordinary (or simple) characters are any characters that are not special. The backslash, "\", is used to convert special characters to ordinary and ordinary characters to special.
141
Example: the pattern "<span class="emphasis"><em>i. love\.</em></span>" will find sentences that end with "h<span class="emphasis"><em>i</em></span>s <span class="emphasis"><em>love</em></span>" or "<span class="emphasis"><em>i</em></span>n <span class="emphasis"><em>love</em></span>" or "<span class="emphasis"><em>i</em></span>s <span class="emphasis"><em>love</em></span>" followed by
142
a period. The first period in "i. love\." is a special character that means allow any character in this position. The
143
backslash in "i. love\." means that the period following it is not to be considered a special character, but is
145
</p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-search-dialog-text-regexp-rules"></a>Rules for Regular Expression Search Requests</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>. The period matches any character.</p></li><li class="listitem"><p>* The asterisk matches 0 or more characters of the
146
preceding: set, character or indicated character.</p></li><li class="listitem"><p>+ The plus sign matches 1 or more characters of the
147
preceding: set, character or indicated character.</p></li><li class="listitem"><p>? The question mark matches 0 or 1 character of the
148
preceding: set, character or indicated character.</p></li><li class="listitem"><p>[ ] Square brackets match any one of the characters
149
specified inside [ ].</p></li><li class="listitem"><p>^ A caret as the first character inside [ ] means NOT.</p></li><li class="listitem"><p>^ A caret beginning a pattern anchors the beginning of a
150
line.</p></li><li class="listitem"><p>$ A dollar at the end of a pattern anchors the end of a
151
line.</p></li><li class="listitem"><p>| A vertical bar means logical OR.</p></li><li class="listitem"><p>( ) Parentheses enclose expressions for grouping.
152
<span class="emphasis"><em>Not supported!</em></span></p></li><li class="listitem"><p>\ A backslash can be used prior to any special character
153
to match that character.</p></li><li class="listitem"><p>\ A backslash can be used prior to an ordinary character
154
to make it a special character.</p></li></ul></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="period"></a>The Period</h5></div></div></div><p>The Period "." will match any single character even
155
a space or other non-alphabet character.
156
<span class="emphasis"><em>s.t</em></span> matches <span class="emphasis"><em>s</em></span>i<span class="emphasis"><em>t</em></span>,
157
<span class="emphasis"><em>s</em></span>e<span class="emphasis"><em>t</em></span>,<span class="emphasis"><em> s</em></span>o<span class="emphasis"><em>t</em></span>,
158
etc., which could be located in <span class="emphasis"><em>s</em></span>i<span class="emphasis"><em>t</em></span>ting,
159
compas<span class="emphasis"><em>s</em></span>e<span class="emphasis"><em>t</em></span>h and <span class="emphasis"><em>s</em></span>o<span class="emphasis"><em>t</em></span>tish
160
<span class="emphasis"><em>b..t</em></span> matches <span class="emphasis"><em>b</em></span>oo<span class="emphasis"><em>t</em></span>,
161
<span class="emphasis"><em>b</em></span>oa<span class="emphasis"><em>t</em></span> and <span class="emphasis"><em>b</em></span>ea<span class="emphasis"><em>t
162
foot.tool </em></span>matches <span class="emphasis"><em>foot</em></span>s<span class="emphasis"><em>tool </em></span>and
163
<span class="emphasis"><em>foot tool</em></span></p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="asterisk"></a>The Asterisk</h5></div></div></div><p>The asterisk "*" matches zero or more characters of the preceding:
164
set, character or indicated character. Using
165
a period asterisk combination ".*" after a commonly
166
found pattern can cause the search to take a very long time,
167
making the program seem to freeze.
168
<span class="emphasis"><em>be*n</em></span> matches<span class="emphasis"><em> beeen, been, ben</em></span>,
169
and <span class="emphasis"><em>bn</em></span> which could locate Reu<span class="emphasis"><em>ben</em></span>
170
and She<span class="emphasis"><em>bn</em></span>a.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="plus"></a>The Plus Sign</h5></div></div></div><p>The Plus Sign "+" matches one or more characters of the preceding:
171
set, character or indicated character. Using
172
a period and plus sign combination ".+" after a
173
commonly found pattern can cause the search to take a very long
174
time, making the program seem to freeze.
175
<span class="emphasis"><em>be+n</em></span> matches <span class="emphasis"><em>beeen, been</em></span> and <span class="emphasis"><em>ben</em></span>,
176
but not <span class="emphasis"><em>bn</em></span>.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="question"></a>The Question Mark</h5></div></div></div><p>The Question Mark "?"matches zero or one character of the
177
preceding: set, character or indicated character.
178
<span class="emphasis"><em>be?n</em></span> matches <span class="emphasis"><em>ben</em></span> and <span class="emphasis"><em>bn</em></span>
179
but not <span class="emphasis"><em>been</em></span>.
180
<span class="emphasis"><em>trees?</em></span> matches <span class="emphasis"><em>trees</em></span> or <span class="emphasis"><em>tree</em></span>.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="bracket"></a>The Square Brackets </h5></div></div></div><p>The Square Brackets "[]" enclose a set of characters that can
181
match. The period, asterisk, plus sign and question mark are not
182
special inside the brackets. A minus sign can be used to indicate
183
a range. If you want a caret "^" to be part of the
184
range do not place it first after the left bracket or it will be
185
a special character. To include a "]" in the set make
186
it the first (or second after a special "^") character
187
in the set. To include a minus sign in the set make it the first
188
(or second after a special "^") or last character in
190
<span class="emphasis"><em>s[eia]t</em></span> matches <span class="emphasis"><em>set</em></span>, <span class="emphasis"><em>sit</em></span>,
191
and <span class="emphasis"><em>sat</em></span>, but not <span class="emphasis"><em>s</em></span>o<span class="emphasis"><em>t</em></span>.
192
<span class="emphasis"><em>s[eia]+t </em></span>matches as above but also, <span class="emphasis"><em>seat,
193
seet, siet</em></span>, etc.
194
<span class="emphasis"><em>[a-d]</em></span> matches <span class="emphasis"><em>a, b, c,</em></span> or <span class="emphasis"><em>d</em></span>.
195
<span class="emphasis"><em>[A-Z]</em></span> matches any uppercase letter.
196
[.;:?!] matches ., ;, :, ?, or ! but not a comma.
197
[ ]^-] matches ] or ^ or -</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="caret"></a>The Caret first in Square Brackets </h5></div></div></div><p>If the Caret is the first character after the left bracket ("[^") it
199
<span class="emphasis"><em>s[^io]t</em></span> matches <span class="emphasis"><em>set, sat</em></span>, etc.,
200
but not <span class="emphasis"><em>s</em></span>i<span class="emphasis"><em>t</em></span> and <span class="emphasis"><em>s</em></span>o<span class="emphasis"><em>t</em></span>.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="caret-s"></a>The Caret as Start of Line Anchor </h5></div></div></div><p>If the Caret is the first character in a pattern ("^xxx") it anchors
201
the pattern to the start of a line. Any match must be at the
202
beginning of a line. Because of unfiltered
203
formatting characters in some texts, this feature does not always
204
work, but may if a few periods are placed after the caret to
205
account for the formatting characters.
206
<span class="emphasis"><em>^In the beginning</em></span> matches lines that
207
start with "<span class="emphasis"><em>In the beginning</em></span>".
208
(May need to use: <span class="emphasis"><em>^.....In the beginning</em></span>)</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="dollar"></a>The Dollar Sign as End of Line Anchor </h5></div></div></div><p>If the Dollar Sign is the last character ("xxx$") in a pattern it
209
anchors the pattern to the end of a line. Any match must be at
210
the end of a line. Because of unfiltered
211
formatting characters in some texts, this feature does not always
212
work, but may if a few periods are placed before the dollar sign
213
to account for the formatting characters.
214
<span class="emphasis"><em>Amen\.$</em></span> matches lines that end with
215
"<span class="emphasis"><em>Amen.</em></span>" (May
216
need to use Amen\....$, Amen\..........$, or even
217
Amen\....................$)</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="bar"></a>The Vertical Bar </h5></div></div></div><p>The Vertical Bar "|" between patterns means OR.
218
<span class="emphasis"><em>John|Peter</em></span> matches <span class="emphasis"><em>John</em></span> or <span class="emphasis"><em>Peter.
219
John .*Peter|Peter .*John</em></span> matches <span class="emphasis"><em>John</em></span>
220
... <span class="emphasis"><em>Peter</em></span> or <span class="emphasis"><em>Peter</em></span> ... <span class="emphasis"><em>John</em></span>.
222
<span class="emphasis"><em>pain|suffering|sorrow</em></span> matches <span class="emphasis"><em>pain</em></span>,
223
or <span class="emphasis"><em>suffering</em></span>, or <span class="emphasis"><em>sorrow</em></span>.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="parenth"></a>The Parentheses</h5></div></div></div><p><span class="emphasis"><em>The use of Parentheses "( )" is
224
not supported!</em></span></p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="backslash"></a>The Backslash Prior to a Special Character</h5></div></div></div><p>The Backslash prior to a special character ("\*") indicates that the
225
character is not being used in its special meaning, but is just
227
<span class="emphasis"><em>amen\.</em></span> matches <span class="emphasis"><em>amen.</em></span> but not <span class="emphasis"><em>amen</em></span>t
228
and will not locate firm<span class="emphasis"><em>amen</em></span>t.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="backslash-o"></a>The Backslash Prior to an Ordinary Character </h5></div></div></div><p>The Backslash prior to an ordinary character ("\o") indicates that
229
the character is not being used to match itself, but has special
230
meaning.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
231
\b if use outside [ ] means word boundary. If used inside [ ] means backspace.
232
<span class="emphasis"><em>\brighteous\b</em></span> matches <span class="emphasis"><em>righteous</em></span> but
233
not un<span class="emphasis"><em>righteous</em></span> or <span class="emphasis"><em>righteous</em></span>ness</p></li><li class="listitem"><p>\B means non-word boundary. <span class="emphasis"><em>\Brighteous\B</em></span>
234
matches un<span class="emphasis"><em>righteous</em></span>ness and un<span class="emphasis"><em>righteous</em></span>ly
235
but not <span class="emphasis"><em>righteous</em></span>, un<span class="emphasis"><em>righteous</em></span> or <span class="emphasis"><em>
236
righteous</em></span>ness.</p></li><li class="listitem"><p>\d means digit; same as [0-9].</p></li><li class="listitem"><p>\D means non-digit, same as [^0-9].</p></li><li class="listitem"><p>\s means space. </p></li><li class="listitem"><p>\S means not a space. </p></li><li class="listitem"><p>\w means alphanumeric; same as [a-zA-Z0-9_].</p></li><li class="listitem"><p>\W means not alphanumeric; same as [^a-zA-Z0-9_].</p></li></ul></div></div></div></div></div></body></html>
b'\\ No newline at end of file'
added
removed
help/C/ar01s06.html
