Skip to content

Commit a0bafe9

Browse files
author
delphidabbler
committed
Edit and correct help topics relating to three search related dialogue boxes
The dialogue boxes are: Find Text, Find Cross Refs and Select Snippets
1 parent c4568ca commit a0bafe9

File tree

3 files changed

+107
-61
lines changed

3 files changed

+107
-61
lines changed

Src/Help/HTML/dlg_findtext.htm

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,36 +41,39 @@ <h1>
4141
</p>
4242
<p>
4343
Enter the text you want to search for in the <em>Text to find</em> combo
44-
box.
44+
box. Recent search text can be accessed from the drop down list.
4545
</p>
4646
<p>
4747
When more than one search word is entered you have a choice of whether to
4848
search for snippets containing all the words, or any of them. You specify
4949
which of these options you want by choosing the relevant radio button in
5050
the <em>Search logic</em> group box. For example, choosing the <em>Find
51-
all words</em> option and searching for &quot;Foo Bar&quot; would match
52-
the text &quot;Foo and Bar&quot; but would not match &quot;Foo&quot; or
53-
&quot;Bar&quot;. Choosing <em>Find and word</em> instead and again
54-
searching for &quot;Foo Bar&quot; would match all the previous examples.
51+
all words</em> option and searching for &quot;<code>Foo Bar</code>&quot;
52+
would match the text &quot;Foo and Bar&quot; but would not match
53+
&quot;Foo&quot; or &quot;Bar&quot;. Choosing <em>Find any word</em>
54+
instead and again searching for &quot;<code>Foo Bar</code>&quot; would
55+
match all the previous examples.
5556
</p>
5657
<p>
5758
There are two more options for further refining the search:
5859
</p>
5960
<ol>
6061
<li>
6162
Use the <em>Whole words only</em> check box to ensure that the search
62-
only looks up words that exactly match those specified. If the check box
63+
only matches words that exactly match those specified. If the check box
6364
is cleared then words containing the specified text will also be found.
64-
For example when the check box is ticked search for &quot;Foo&quot; will
65-
not match &quot;FooBar&quot;, but when the check box is cleared, the two
66-
words will match.
65+
For example when the check box is ticked a search for
66+
&quot;<code>Foo</code>&quot; will match &quot;Foo&quot; in
67+
&quot;Foo Bar&quot; but will not match &quot;FooBar&quot;. When the
68+
check box is cleared, &quot;<code>Foo</code>&quot; will match both
69+
examples.
6770
</li>
6871
<li>
6972
Make the search case sensitive by checking the <em>Case sensitive</em>
70-
check box. In this case searching for &quot;Foo&quot; would only match
71-
the exact text and would not match &quot;foo&quot or &quot;FOO&quot;.
72-
If the check box is cleared then case is ignored. Now searching for
73-
&quot;Foo;&quot; will match both &quot;foo&quot and &quot;FOO&quot;.
73+
check box. In this case searching for &quot;<code>Foo</code>&quot; will
74+
match &quot;Foo&quot; but not &quot;foo&quot; or &quot;FOO&quot;. If the
75+
check box is cleared then case is ignored and searching for
76+
&quot;<code>Foo</code>&quot; again will match all three examples.
7477
</li>
7578
</ol>
7679
<p>
@@ -88,10 +91,9 @@ <h1>
8891
remains unchanged.
8992
</p>
9093
<p>
91-
The <em>Search scope</em> group box is disabled if there was no existing
92-
search when this dialogue box was opened, and the search operates on the
93-
entire database.
94+
The <em>Search scope</em> group box is disabled if there was no previous
95+
search active when this dialogue box was opened. The search will operate
96+
on the entire database.
9497
</p>
9598
</body>
9699
</html>
97-

Src/Help/HTML/dlg_findxrefs.htm

Lines changed: 69 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,56 +28,97 @@ <h1>
2828
</h1>
2929
<p>
3030
Use this dialogue box to find snippets that are referenced by the
31-
currently selected snippet and / or those snippets reference that snippet.
32-
The dialogue is displayed from the <em>Search | Find Cross Refs</em> menu
33-
option.
31+
currently selected snippet and / or those snippets that reference the
32+
snippet. The dialogue is displayed from the <em>Search | Find Cross
33+
Refs</em> menu option.
3434
</p>
3535
<p>
36-
The search can be customised by checking or clearing the following check
36+
The dialogue enables two kinds of cross-references to be found:
37+
</p>
38+
<ol>
39+
<li>
40+
Snippet dependencies, which are snippets that the selected snippet
41+
depends upon in order to compile. Alternatively the search can find
42+
snippets that depend on the selected one.
43+
</li>
44+
<li>
45+
&quot;See also&quot; references, which are snippets that are related to
46+
the selected snippet conceptually. Such snippets are not necessarily
47+
needed to compile the selected snippet. Alternatively the search can
48+
find snippets that refer to the selected one as a &quot;see also&quot;
49+
snippet.
50+
</li>
51+
</ol>
52+
<p>
53+
The search is customised by checking or clearing the following check
3754
boxes:
3855
</p>
3956
<ul>
4057
<li>
41-
<em>Search for required snippets</em>. Selecting this option causes
42-
all snippets that are needed to compile the selected snippet to be
43-
included in the search result. If the related <em>Search
44-
recursively</em> box is checked the search continues through the found
45-
snippets.
58+
<p>
59+
<em>Search for required snippets</em>
60+
</p>
61+
<p>
62+
Selecting this option includes all snippets that the selected snippet
63+
depends upon in the search result.
64+
</p>
65+
<p>
66+
If the related <em>Search recursively</em> box is checked the search
67+
is applied recursively to all the found snippets.
68+
</p>
4669
</li>
4770
<li>
48-
<em>Search for snippets that depend on this one</em>. Choose this option
49-
to include in the search results all snippets that depend upon (i.e.
50-
require) this one.
71+
<p>
72+
<em>Search for snippets that depend on this one</em>
73+
</p>
74+
<p>
75+
Choose this option to include in the search results all snippets that
76+
depend upon this one.
77+
</p>
5178
</li>
5279
<li>
53-
<em>Search for &quot;see also&quot; cross references</em>. This option
54-
includes snippets referenced as &quot;see also&quot; to be included in
55-
the search result. These snippets are not necessarily needed to compile
56-
the selected snippet, but are related to it conceptually. Again,
57-
checking the related <em>Search recursively</em> check box causes the
58-
search to recurse through the found &quot;see also&quot; cross
59-
references.
80+
<p>
81+
<em>Search for &quot;see also&quot; cross references</em>
82+
</p>
83+
<p>
84+
This option includes all snippets referenced as &quot;see also&quot;
85+
in the search result.
86+
</p>
87+
<p>
88+
Checking the related <em>Search recursively</em> check box causes the
89+
search to recurse through all the found snippets' &quot;see also&quot;
90+
cross references.
91+
</p>
6092
</li>
6193
<li>
62-
<em>Search for snippets that cross-reference this one</em>. Choose this
63-
option to include in the search results all snippets that
64-
cross-reference this one.
94+
<p>
95+
<em>Search for snippets that cross-reference this one</em>
96+
</p>
97+
<p>
98+
Choose this option to include all snippets that cross-reference this
99+
one in the search results.
100+
</p>
65101
</li>
66102
<li>
67-
<em>Include &quot;xxxx&quot; in search</em> (where xxxx is the name of
68-
the selected snippet). Checking this box simply includes the selected
69-
snippet in the search results.
103+
<p>
104+
<em>Include &quot;xxxx&quot; in search</em> (where xxxx is the name of
105+
the selected snippet).
106+
</p>
107+
<p>
108+
Checking this box simply includes the selected snippet in the search
109+
results.
110+
</p>
70111
</li>
71112
</ul>
72113
<p>
73114
You must check at least one of the <em>Search for required snippets</em>
74115
or <em>Search for &quot;see also&quot; cross references</em> options.
75116
</p>
76117
<p>
77-
<strong>NOTE:</strong> Any cross references selected using this dialogue
78-
box will replace any search results that were previously displayed. A
118+
<strong>Note:</strong> Snippets selected by the use of this dialogue box
119+
will replace any search results that were previously displayed. A
79120
message to this effect will be displayed in the dialogue box if it is
80-
displayed when search results are being displayed.
121+
opened while a previous search is active.
81122
</p>
82123
</body>
83124
</html>

Src/Help/HTML/dlg_selectroutines.htm

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,48 +41,51 @@ <h1>
4141
Snippets are displayed sorted under categories. When the dialogue box
4242
opens only the categories are shown. They can be expanded and collapsed
4343
in the usual way: by clicking the arrow symbols (or plus/minus symbols)
44-
that appear to the left of the categories; by double clicking the
45-
category; by using the <span class="smallcaps">Left</span>,
44+
that appear to the left of the categories, by double clicking the
45+
category or by using the <span class="smallcaps">Left</span>,
4646
<span class="smallcaps">Right</span> and
4747
<span class="smallcaps">Enter</span> keys. Alternatively use the
4848
<em>Expand All</em> and <em>Collapse All</em> buttons on the right of
4949
the dialogue box.
5050
</p>
5151
<p>
52-
Snippets are selected simply by placing a check mark next to the name of
53-
the required snippets. Checking or unchecking a category will select or
52+
Snippets are selected by placing a check mark next to the name of the
53+
required snippets. Checking or unchecking a category will select or
5454
de-select all the snippets in the category. When the dialogue box appears
55-
all snippets currently displayed by the program are selected.
55+
all snippets currently displayed by the program are pre-selected.
5656
</p>
5757
<p>
5858
There are also four buttons that can be used to select or deselect groups
5959
of snippets. The options are:
6060
</p>
6161
<ul>
6262
<li>
63-
<em>Select All</em> selects all the snippets in the database.
63+
<em>Select All</em><br>
64+
Selects all the snippets in the database.
6465
</li>
6566
<li>
66-
<em>Clear All</em> deselects all the snippets in the database.
67+
<em>Clear All</em><br>
68+
Deselects all the snippets in the database.
6769
</li>
6870
<li>
69-
<em>User Defined</em> selects all the user defined snippets in the
70-
database. The button will be disabled if there are no user defined
71-
snippets.
71+
<em>User Defined</em><br>
72+
Selects all the user defined snippets in the database. The button will
73+
be disabled if there are no user defined snippets.
7274
</li>
7375
<li>
74-
<em>Main</em> selects all the snippets in the main database.
76+
<em>Main</em><br>
77+
Selects all the snippets in the main database.
7578
</li>
7679
</ul>
7780
<p>
78-
When the selection has been made, click the <em>OK</em> to accept the
79-
changes. At least one snippet must be selected. Click <em>Cancel</em> to
80-
abort your selection.
81+
When the selection has been made, click the <em>OK</em> button to accept
82+
the changes. At least one snippet must be selected. Click <em>Cancel</em>
83+
to abort your selection.
8184
</p>
8285
<p>
83-
<strong>NOTE:</strong> Any selection made using this dialogue box will
86+
<strong>Note:</strong> Any selection made using this dialogue box will
8487
replace any search results that were previously displayed. A message to
85-
this effect will be displayed in the dialogue box if it is displayed when
88+
this effect will be displayed in the dialogue box if it is opened while
8689
search results are being displayed.
8790
</p>
8891
<p>

0 commit comments

Comments
 (0)