Skip to content

Commit 934c5bb

Browse files
author
delphidabbler
committed
Merge branch 'feature/revise-settings' into develop
2 parents d012478 + 1e96923 commit 934c5bb

15 files changed

+162
-861
lines changed

‎Docs/Design/FileFormats/config.html

Lines changed: 53 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ <h2>
8484
</p>
8585

8686
<p>
87-
On earlier versions of CodeSnip the config files were ANSI text files using the system's default encoding. The installer takes care of converting the older ANSI files to Unicode.
87+
On earlier versions of CodeSnip the config files were ANSI text files using the system's default encoding. CodeSnip v4 and the standard edition's installer convert the older ANSI files to Unicode.
8888
</p>
8989

9090
<h2>
@@ -95,8 +95,12 @@ <h3>
9595
Common Config File
9696
</h3>
9797

98+
<p class="pullout">
99+
<strong>Note:</strong> From CodeSnip v4.16 this file is used only by the installer of the standard edition. The portable edition does not use the file and does not create it.
100+
</p>
101+
98102
<p>
99-
This file stores information about CodeSnip that is common to all users. The file is named <code>Common.config</code>. The standard version of CodeSnip stores this file in the <code>%ProgramData%\DelphiDabbler\CodeSnip.4</code> directory, while the portable version stores it in the <code>AppDir</code> sub-directory of the folder where CodeSnip is installed.
103+
The file stores information about the current version of the program. It is named <code>Common.config</code>. The file is stored in the standard edition's <code>%ProgramData%\DelphiDabbler\CodeSnip.4</code> directory.
100104
</p>
101105

102106
<p>
@@ -120,12 +124,6 @@ <h4>
120124
</p>
121125

122126
<dl class="indent">
123-
<dt class="del">
124-
<code class="key">Key</code> (String)
125-
</dt>
126-
<dd class="del">
127-
Unique application ID. String of 32 hex digits.
128-
</dd>
129127
<dt>
130128
<code class="key">Version</code> (String)
131129
</dt>
@@ -317,7 +315,7 @@ <h4>
317315
</dt>
318316
<dd>
319317
<div class="half-spaced">
320-
Once entry for each search directory configured for the compiler where <code class="key"<em>XXX</code> ranges from <code class="value">0</code> to <code class="key">SearchDirCount</code> - <code class="value">1</code>.
318+
One entry for each search directory configured for the compiler where <code class="key"<em>XXX</code> ranges from <code class="value">0</code> to <code class="key">SearchDirCount</code> - <code class="value">1</code>.
321319
</div>
322320
<div class="half-spaced">
323321
Each entry contains a fully specified directory path.
@@ -1153,13 +1151,12 @@ <h4>
11531151
</dd>
11541152
</dl>
11551153

1156-
<div class="del">
11571154
<h4>
1158-
[Prefs:Updating] section
1155+
[UnitList] section
11591156
</h4>
11601157

11611158
<p>
1162-
Stores preferences relating to updating CodeSnip and the local copy of the online database.
1159+
Records the names of the units that appear in the <em>Units</em> check box list on the <em>References</em> tab of the <em>Edit Snippet</em> dialoogue box.
11631160
</p>
11641161

11651162
<p>
@@ -1168,132 +1165,70 @@ <h4>
11681165

11691166
<dl class="indent">
11701167
<dt>
1171-
<strong>AutoCheckProgramFrequency</strong> (Integer)
1168+
<code class="key">Count</code> (Integer)
11721169
</dt>
11731170
<dd>
1174-
Specifies frequency, in days, with which CodeSnip automatically checks online for program updates. A value of 0 indicates that CodeSnip will not check for program updates automatically.
1171+
The number of units in the list.
11751172
</dd>
11761173
<dt>
1177-
<strong>AutoCheckDatabaseFrequency</strong> (Integer)
1174+
<code class="key">Unit<em>XXX</em></code> (String)
11781175
</dt>
11791176
<dd>
1180-
Specifies frequency, in days, with which CodeSnip automatically checks online for database updates. A value of 0 indicates that CodeSnip will not check for database updates automatically.
1177+
One entry for each unit, where <code class="key">XXX</code> range from <code class="value">0</code> to <code class="key">Count</code> - <code class="value">1</code>.
11811178
</dd>
11821179
</dl>
1183-
</div>
1184-
1185-
<div class="del">
1186-
<h4>
1187-
[ProxyServer] section
1188-
</h4>
1189-
1190-
<p>
1191-
Stores information about any proxy internet server that is to be used.
1192-
</p>
11931180

11941181
<p>
1195-
Name / Value pairs:
1182+
Note that some &quot;reserved&quot; unit names that always appear in the list box are not recorded in settings. They are:
11961183
</p>
11971184

1198-
<dl class="indent">
1199-
<dt>
1200-
<strong>UseProxy</strong> (Boolean)
1201-
</dt>
1202-
<dd>
1203-
Flag that indicates whether to use a proxy server or not. If false the remaining name / value pairs in this section are ignored.
1204-
</dd>
1205-
<dt>
1206-
<strong>IPAddress</strong> (String)
1207-
</dt>
1208-
<dd>
1209-
IP address of proxy server in dotted quad format, e.g. 127.0.0.1.
1210-
</dd>
1211-
<dt>
1212-
<strong>Port</strong> (Integer)
1213-
</dt>
1214-
<dd>
1215-
Port on which to access proxy server.
1216-
</dd>
1217-
<dt>
1218-
<strong>UserName</strong> (String)
1219-
</dt>
1220-
<dd>
1221-
Username for proxy server access. Empty if server doesn't require a user
1222-
name.
1223-
</dd>
1224-
<dt>
1225-
<strong>Password</strong> (String)
1226-
</dt>
1227-
<dd>
1228-
Encrypted form of any password required to access proxy server. Empty if no
1229-
password is required. This value is a hex representation of the bytes of
1230-
the encrypted password.
1231-
</dd>
1232-
</dl>
1233-
</div>
1234-
1235-
<div class="del">
1236-
<h4>
1237-
[UpdateChecks] section
1238-
</h4>
1239-
1240-
<p>
1241-
Records date of last (automatic) update checks for different items. These
1242-
values are used to determine when to perform the next check. (Checks are made
1243-
within a fixed interval of the preceding check).
1244-
</p>
1185+
<ul class="unspaced">
1186+
<li>
1187+
<var>SysUtils</var>
1188+
</li>
1189+
<li>
1190+
<var>Classes</var>
1191+
</li>
1192+
<li>
1193+
<var>Windows</var>
1194+
</li>
1195+
<li>
1196+
<var>Graphics</var>
1197+
</li>
1198+
</ul>
12451199

12461200
<p>
1247-
Name / Value pairs:
1201+
If this section is missing or has no units listed then CodeSnip defaults to using the following units in addition to the &quot;reserved&quot; units:
12481202
</p>
12491203

1250-
<dl class="indent">
1251-
<dt>
1252-
<strong>LastProgramCheck</strong> (Date-Time)
1253-
</dt>
1254-
<dd>
1255-
Date (in GMT) that the program last checked to see if a new version of
1256-
CodeSnip is available.
1257-
</dd>
1258-
<dt>
1259-
<strong>LastDatabaseCheck</strong> (Date-Time)
1260-
</dt>
1261-
<dd>
1262-
Date (in GMT) that the program last checked to see if the online version of
1263-
the Code Snippets Database had been updated.
1264-
</dd>
1265-
</dl>
1266-
</div>
1267-
1268-
<div class="del">
1269-
<h4>
1270-
[UserInfo] section
1271-
</h4>
1272-
1273-
<p>
1274-
Stores personal information about the user.
1275-
</p>
1204+
<ul class="unspaced">
1205+
<li>
1206+
<var>Controls</var>
1207+
</li>
1208+
<li>
1209+
<var>Messages</var>
1210+
</li>
1211+
<li>
1212+
<var>Types</var>
1213+
</li>
1214+
<li>
1215+
<var>ShlObj</var>
1216+
</li>
1217+
<li>
1218+
<var>ShellAPI</var>
1219+
</li>
1220+
<li>
1221+
<var>ActiveX</var>
1222+
</li>
1223+
<li>
1224+
<var>Math</var>
1225+
</li>
1226+
</ul>
12761227

12771228
<p>
1278-
Name / Value pairs:
1229+
These default unit names will be included in this section the first time it is written.
12791230
</p>
12801231

1281-
<dl class="indent">
1282-
<dt>
1283-
<strong>Name</strong> (String)
1284-
</dt>
1285-
<dd>
1286-
User's name.
1287-
</dd>
1288-
<dt>
1289-
<strong>Email</strong> (String)
1290-
</dt>
1291-
<dd>
1292-
User's email address.
1293-
</dd>
1294-
</dl>
1295-
</div>
1296-
12971232
<h4>
12981233
[WindowState:<em>XXX</em>] sections
12991234
</h4>

‎Docs/License.html

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1826,12 +1826,6 @@ <h1>
18261826
are willingly made:
18271827
</p>
18281828
<ul>
1829-
<li>
1830-
Thanks to Steve Schafer of TeamB (<a
1831-
href="http://www.teamb.com/"
1832-
>http://www.teamb.com/</a>) for the code on which the program's encryption
1833-
support is based.
1834-
</li>
18351829
<li>
18361830
<em>CodeSnip</em>'s installer was created using <em>Inno Setup</em>: see
18371831
<a

0 commit comments

Comments
 (0)