Skip to content

Commit e169b47

Browse files
delphidabblerdelphidabbler
committed
Update help files for compiler registration changes
Add & update help re auto-detect compiler feature Add new dlg_registercompilers.htm and task_registercompilers.htm help topics. Noted new option to switch off compiler auto-detection. Update other topics re the new topics and auto-detection feature. Update help project, index and TOC files re new topics.
1 parent ebcadfd commit e169b47

8 files changed

+276
-10
lines changed

‎Src/Help/CodeSnip.hhp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ HTML\dlg_prefs_printing.htm
5353
HTML\dlg_prefs_snippetlayout.htm
5454
HTML\dlg_prefs_sourcecode.htm
5555
HTML\dlg_print.htm
56+
HTML\dlg_registercompilers.htm
5657
HTML\dlg_renamecategory.htm
5758
HTML\dlg_restore.htm
5859
HTML\dlg_savehiliter.htm
@@ -101,6 +102,7 @@ HTML\task_deleteuserdb.htm
101102
HTML\task_export.htm
102103
HTML\task_generateunit.htm
103104
HTML\task_printroutine.htm
105+
HTML\task_registercompilers.htm
104106
HTML\task_savesnippet.htm
105107
HTML\task_search.htm
106108
HTML\task_testcompile.htm

‎Src/Help/HTML/about_compiler_checks.htm

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ <h2>
4141
</h2>
4242
<p>
4343
Before <em>CodeSnip</em> can use the compilers it needs to be told about
44-
them. This is done using the <a
44+
them. Compilers are registered for use by <em>CodeSnip</em> This is done
45+
using the <a
4546
href="dlg_configcompilers.htm">Configure Compilers</a> dialogue box that
4647
is accessed from the <em>Tools</em> menu.
4748
</p>
@@ -60,7 +61,26 @@ <h2>
6061
different compiler switches and search paths.
6162
</p>
6263
<p>
63-
The portable version of CodeSnip only maintains one set of compiler configuration information per installation.
64+
The portable version of CodeSnip only maintains one set of compiler
65+
configuration information per installation.
66+
</p>
67+
<h3>
68+
Automatic detection of Delphi compilers
69+
</h3>
70+
<p>
71+
By default, when <em>CodeSnip</em> starts up, it will check if there are
72+
any versions of Delphi installed on the user's system that
73+
<em>CodeSnip</em> could use, but that are not registered for use. Any such
74+
compilers are displayed in the <a
75+
href="dlg_registercompilers.htm"
76+
>Unregistered Delphi Installation(s) Detected</a> dialogue box where you
77+
can choose whether or not to register them.
78+
</p>
79+
<p>
80+
It is possible to switch off automatic detection on either a global or a
81+
per compiler basis. For more information see the <a
82+
href="task_registercompilers.htm"
83+
>Register Compilers with <em>CodeSnip</em></a> topic.
6484
</p>
6585
<h2>
6686
Running the tests

‎Src/Help/HTML/dlg_configcompilers.htm

Lines changed: 49 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ <h1>
3737
Compilers that are installed on the system. It is displayed using the
3838
<em>Tools | Configure Compilers</em> menu option. <em>CodeSnip</em> uses
3939
these compilers when <a href="about_compiler_checks.htm">test
40-
compiling</a> routines.
40+
compiling</a> snippets.
4141
</p>
4242
<p class="bordered">
4343
When using the standard version of CodeSnip each logged on user has their
44-
their own compiler configuration, so any changes you make will not affect
45-
other users. The portable edition of CodeSnip only supports one set of
44+
own compiler configuration, so any changes you make will not affect other
45+
users. The portable edition of CodeSnip only supports one set of
4646
configuration data per installation.
4747
</p>
4848
<p>
@@ -54,11 +54,14 @@ <h1>
5454
<p>
5555
Selecting a compiler on the left displays information about it on the
5656
right hand side of the dialogue. Here you enter or edit the required
57-
information on three tabs, as follows.
57+
information on four or five tabs, as follows.
5858
</p>
5959
<h2>
6060
Compiler Tab
6161
</h2>
62+
<h3>
63+
Compiler file name
64+
</h3>
6265
<p>
6366
Enter the the full path to the compiler's executable file in the <em>Enter
6467
compiler executable file name</em> edit box. This must be file name of
@@ -75,8 +78,11 @@ <h2>
7578
path to its executable file. The <em>Enter compiler executable file
7679
name</em> edit box is cleared.
7780
</p>
81+
<h3>
82+
Display compiler results
83+
</h3>
7884
<p>
79-
Finally, you can choose whether the compiler is included in the table of
85+
You can choose whether the compiler is included in the table of
8086
compile results displayed in the <a href="detail_pane.htm">Details
8187
Pane</a>. This is done using the <em>Display results for this compiler in
8288
details pane</em> check box. Tick the box to display the compiler's
@@ -97,6 +103,31 @@ <h2>
97103
remove the <em>Compiler Results Table</em> component from the different
98104
kinds of snippet pages.
99105
</p>
106+
<h3>
107+
Automatic compiler detection &amp; registration
108+
</h3>
109+
<p>
110+
By default <em>CodeSnip </em> will automatically detect and register
111+
installed Delphi compilers for use with the program. This can happen in
112+
two ways:
113+
</p>
114+
<ol>
115+
<li>
116+
When the <em>Detect Delphi Compilers</em> button is clicked (see below).
117+
</li>
118+
<li>
119+
Optionally, when the program starts up.
120+
</li>
121+
</ol>
122+
<p>
123+
You can prevent a specific Delphi compiler from being automatically
124+
registered by clearing the <em>Permit auto-detection & registration of
125+
this compiler</em> check box.
126+
</p>
127+
<p class="bordered">
128+
<strong>Note:</strong> This check box does not appear when the Free Pascal
129+
compiler is selected.
130+
</p>
100131
<h2>
101132
Switches Tab
102133
</h2>
@@ -283,13 +314,23 @@ <h2>
283314
<em>CodeSnip</em> can automatically detect the presence of Win 32 Delphi
284315
compilers from Delphi 2 to Delphi 11.x Alexandria. Click the <em>Detect
285316
Delphi Compilers</em> button to do this. Any supported installed version
286-
of Delphi will be recorded. This can save considerable time and avoid
287-
errors.
317+
of Delphi will be recorded<sup>&dagger;</sup>. This can save considerable
318+
time and avoid errors.
288319
</p>
289320
<p>
290321
Free Pascal cannot be detected automatically and must be configured
291322
manually.
292323
</p>
324+
<p>
325+
If the <em>Automatically register newly installed Delphi compilers at
326+
program startup</em> check box is ticked then, when it starts up,
327+
<em>CodeSnip</em> will attempt to register any known Delphi compiler that
328+
is not yet registered with Delphi<sup>&dagger;</sup>.
329+
</p>
330+
<p class="bordered">
331+
&dagger; Any version of Delphi for which the <em>Permit auto-detection
332+
&amp; registration of this compiler</em> check box is cleared will not be
333+
recorded.
334+
</p>
293335
</body>
294336
</html>
295-

‎Src/Help/HTML/dlg_registercompilers.htm

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2+
<!--
3+
* This Source Code Form is subject to the terms of the Mozilla Public License,
4+
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
5+
* obtain one at https://mozilla.org/MPL/2.0/
6+
*
7+
* Copyright (C) 2022, Peter Johnson (gravatar.com/delphidabbler).
8+
*
9+
* Help topic for Unregistered Delphi Installation(s) dialogue box.
10+
-->
11+
<html>
12+
<head>
13+
<meta http-equiv="Content-Type" content="text-html; charset=Windows-1252">
14+
<title>
15+
Unregistered Delphi Installation(s) Detected Dialogue Box
16+
</title>
17+
<link rel="stylesheet" href="../css/codesnip.css" type="text/css">
18+
</head>
19+
<body>
20+
<object
21+
type="application/x-oleobject"
22+
classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e"
23+
>
24+
<param name="ALink Name" value="RegisterCompilersDlg">
25+
</object>
26+
<h1>
27+
<a name="dlg_registercompilers"></a>Unregistered Delphi Installation(s)
28+
Detected Dialogue Box
29+
</h1>
30+
<p>
31+
This dialogue box is displayed at program start-up if <em>CodeSnip</em>
32+
detects that Delphi compilers are installed on the user's system that have
33+
not yet been registered for use by <em>CodeSnip</em>.
34+
</p>
35+
<p>
36+
The available compilers are listed at the top of the dialogue box. Each
37+
compiler has a check box to its left. You should tick this check box to
38+
permit <em>CodeSnip</em> to register the compiler or leave it clear if you
39+
don't want to register the compiler with <em>CodeSnip</em>.
40+
</p>
41+
<p>
42+
Underneath the list of compilers are some instructions about how to
43+
disable auto-registration of some or all compilers.
44+
</p>
45+
<p>
46+
Once you have made your selection click the <em>OK</em> button to register
47+
the selected compilers with <em>CodeSnip</em>. A message box will pop up
48+
to confirm that the compilers have been registered.
49+
</p>
50+
<h2>
51+
Preventing automatic detection
52+
</h2>
53+
<p>
54+
You can prevent <em>CodeSnip</em> from checking for <strong>any</strong>
55+
new compilers on startup in future by ticking the <em>Don't show this
56+
again</em> check box before clicking <em>OK</em>.
57+
</p>
58+
<p>
59+
If you change your mind startup checks can be re-enabled. Alternatively
60+
you can exclude individual Delphi compilers from automatic detection.
61+
For information about how to do this see <a
62+
href="task_registercompilers.htm"
63+
>Register Compilers with <em>CodeSnip</em></a>.
64+
</p>
65+
</body>
66+
</html>

‎Src/Help/HTML/task_registercompilers.htm

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
2+
<!--
3+
* This Source Code Form is subject to the terms of the Mozilla Public License,
4+
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
5+
* obtain one at https://mozilla.org/MPL/2.0/
6+
*
7+
* Copyright (C) 2022, Peter Johnson (gravatar.com/delphidabbler).
8+
*
9+
* Hell topic describing how to register compilers with CodeSnip.
10+
-->
11+
<html>
12+
<head>
13+
<meta http-equiv="Content-Type" content="text-html; charset=Windows-1252">
14+
<title>
15+
Register Compilers
16+
</title>
17+
<link rel="stylesheet" href="../css/codesnip.css" type="text/css">
18+
</head>
19+
<body>
20+
<object
21+
type="application/x-oleobject"
22+
classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e"
23+
>
24+
<param name="ALink Name" value="TaskRegisterCompilers">
25+
</object>
26+
<h1>
27+
<a name="task_registercompilers"></a>Register Compilers with
28+
<em>CodeSnip</em>
29+
</h1>
30+
<p>
31+
Before you can <a
32+
href="task_testcompile.htm"
33+
>test compile</a> a snippet you must first register one or more installed
34+
compilers with <em>CodeSnip</em>.
35+
</p>
36+
<p>
37+
To do this you must tell <em>CodeSnip</em> how to find the compiler and
38+
configure the required options for it. There are three ways to do this:
39+
</p>
40+
<ol>
41+
<li>
42+
<p>
43+
Manually configure the compiler using the <a
44+
href="dlg_configcompilers.htm"
45+
>Configure Compilers</a> dialogue box, accessed from the <em>Tools |
46+
Configure Compilers</em> dialogue box.
47+
</p>
48+
<p class="bordered">
49+
<strong>Note:</strong> This is the only option available for Free
50+
Pascal.
51+
</p>
52+
</li>
53+
<li>
54+
<p>
55+
Use the <em>Detect Delphi Compilers</em> button in the <a
56+
href="dlg_configcompilers.htm"
57+
>Configure Compilers</a> dialogue box. This searches for any installed
58+
Delphi compilers that are not registered and registers them. Any
59+
compilers for which automatic detection has been disabled is ignored
60+
(see below).
61+
</p>
62+
</li>
63+
<li>
64+
<p>
65+
By default <em>CodeSnip</em> checks for any un-registered installed
66+
version of Delphi at start-up, and offers to register them by popping
67+
up the <a
68+
href="dlg_registercompilers.htm"
69+
>Unregistered Delphi Installation(s) Detected Dialogue Box</a>.
70+
</p>
71+
</li>
72+
</ol>
73+
<h3>
74+
Inhibiting Auto-Detection
75+
</h3>
76+
<p>
77+
If you don't want <em>CodeSnip</em> to detect any new, unregistered,
78+
Delphi compilers at startup you can switch the feature off entirely from
79+
the <a
80+
href="dlg_registercompilers.htm"
81+
>Unregistered Delphi Installation(s) Detected Dialogue Box</a>, by ticking
82+
the <em>Don't show this again</em> check box. You can do the same thing
83+
from the <a
84+
href="dlg_configcompilers.htm"
85+
>Configure Compilers</a> dialogue box by clearing the <em>Automatically
86+
register newly installed Delphi compilers at startup</em> check box.
87+
</p>
88+
<p>
89+
Alternatively, if you don't want <em>CodeSnip</em> to automatically detect
90+
one or more specific Delphi compilers you can do that in the <a
91+
href="dlg_configcompilers.htm"
92+
>Configure Compilers</a> dialogue box. You just need to clear the
93+
<em>Permit auto-detection &amp; registration of this compiler</em> check
94+
box on a selected compiler's <em>Compiler</em> tab. If you do this then
95+
<em>CodeSnip</em> will not suggest registering that compiler at startup.
96+
The <a
97+
href="dlg_configcompilers.htm"
98+
>Configure Compilers</a> dialogue box's <em>Detect Delphi Compilers</em>
99+
feature will ignore them too.
100+
</p>
101+
<h3>
102+
(Re-)enabling Auto-Detection
103+
</h3>
104+
<p>
105+
Global automatic detection can be enabled from the <a
106+
href="dlg_configcompilers.htm"
107+
>Configure Compilers</a> dialogue box by ticking the <em>Automatically
108+
register newly installed Delphi compilers at startup</em> check box.
109+
</p>
110+
<p>
111+
Individually excluded compilers can be included in automatic detection
112+
again by ticking the <em>Permit auto-detection &amp; registration of this
113+
compiler</em> check box on a selected compiler's <em>Compiler</em> tab in
114+
the <a
115+
href="dlg_configcompilers.htm"
116+
>Configure Compilers</a> dialogue box.
117+
</p>
118+
</body>
119+
</html>
120+

‎Src/Help/HTML/tasks.htm

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ <h1>
4242
</li>
4343
<li>
4444
<a href="task_printroutine.htm">Print Information about a Snippet</a>
45+
</li>
4546
<li>
4647
<a href="task_generateunit.htm">Generate a Pascal Unit</a>
4748
</li>
@@ -51,6 +52,10 @@ <h1>
5152
<li>
5253
<a href="task_testcompile.htm">Test Compile a Snippet</a>
5354
</li>
55+
<li>
56+
<a href="task_registercompilers.htm">Register a Compiler for Test
57+
Compilation</a>
58+
</li>
5459
<li>
5560
<a href="task_update.htm">Install or Update the DelphiDabbler Code
5661
Snippets Database</a>

‎Src/Help/Index.hhk

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@
9999
<param name="Name" value="test compiling">
100100
<param name="Local" value="HTML\task_testcompile.htm">
101101
</OBJECT>
102+
<LI> <OBJECT type="text/sitemap">
103+
<param name="Name" value="compiler registration">
104+
<param name="Local" value="HTML\task_registercompilers.htm">
105+
</OBJECT>
102106
<LI> <OBJECT type="text/sitemap">
103107
<param name="Name" value="update the database">
104108
<param name="Local" value="HTML\task_update.htm">
@@ -146,6 +150,10 @@
146150
<param name="Name" value="display preferences">
147151
<param name="Local" value="HTML\dlg_prefs_display.htm">
148152
</OBJECT>
153+
<LI> <OBJECT type="text/sitemap">
154+
<param name="Name" value="auto-register Delphi compilers dialogue">
155+
<param name="Local" value="HTML\dlg_registercompilers.htm">
156+
</OBJECT>
149157
<LI> <OBJECT type="text/sitemap">
150158
<param name="Name" value="download database">
151159
<param name="Local" value="HTML\task_update.htm">

‎Src/Help/TOC.hhc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@
132132
<param name="Name" value="Test Compile Snippet">
133133
<param name="Local" value="HTML\task_testcompile.htm">
134134
</OBJECT>
135+
<LI> <OBJECT type="text/sitemap">
136+
<param name="Name" value="Register Compilers For Test Compilation">
137+
<param name="Local" value="HTML\task_registercompilers.htm">
138+
</OBJECT>
135139
<LI> <OBJECT type="text/sitemap">
136140
<param name="Name" value="Customise CodeSnip">
137141
<param name="Local" value="HTML\task_customise.htm">

0 commit comments

Comments
 (0)