Skip to content

Commit 99552f5

Browse files
committed
Some formatting changes.
Corrected some errors. Shortened section on ignored "MinVer" value.
1 parent 18fb859 commit 99552f5

File tree

1 file changed

+64
-49
lines changed

1 file changed

+64
-49
lines changed

Docs/Design/FileFormats/main-db.html

Lines changed: 64 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ <h2>
7575
</h2>
7676

7777
<p>
78-
CodeSnip 4 stores all main database files, including the subsidiary text
78+
CodeSnip v4 stores all main database files, including the subsidiary text
7979
files, using UTF-8 encoding. Files are saved with the UTF-8 preamble (BOM).
8080
</p>
8181

@@ -173,11 +173,16 @@ <h3>
173173
<em>DisplayName</em>
174174
</dt>
175175
<dd>
176-
Display name of snippet. If present this value is used in the program GUI as
177-
the snippet's name. The value is optional. If not present the name of the
178-
section is used as the display name. There are no restriction on the
179-
characters used. Supported from CodeSnip v4.0 beta 1 and ignored by earler
180-
versions which always use the section name as display name.
176+
<div class="half-spaced">
177+
Display name of snippet. If present this value is used in the program GUI
178+
as the snippet's name. The value is optional. If not present the name of
179+
the section is used as the display name. There are no restriction on the
180+
characters used.
181+
</div>
182+
<div class="half-spaced">
183+
Supported from CodeSnip v4.0 beta 1 and ignored by earlier versions which
184+
always use the section name as display name.
185+
</div>
181186
</dd>
182187
<dt>
183188
<em>Desc</em>
@@ -190,11 +195,16 @@ <h3>
190195
<em>DescEx</em>
191196
</dt>
192197
<dd>
193-
Formatted description of the snippet using <acronym
194-
title="REML is decribed in the program's help file"
195-
>REML</acronym> code. This value was supported from CodeSnip v4.0 beta 1.
196-
May be empty, in which case the <em>Desc</em> field is used. The
197-
<em>Desc</em> field is ignored if <em>DescEx</em> has a value.
198+
<div class="half-spaced">
199+
Formatted description of the snippet using <acronym
200+
title="REML is decribed in the program's help file"
201+
>REML</acronym> code. May be empty, in which case the <em>Desc</em> field
202+
is used. The <em>Desc</em> field is ignored if <em>DescEx</em> has a
203+
value.
204+
</div>
205+
<div class="half-spaced">
206+
Supported from CodeSnip v4.0 beta 1.
207+
</div>
198208
</dd>
199209
<dt>
200210
<em>Snip</em>
@@ -247,16 +257,21 @@ <h3>
247257
<em>Credits_URL</em>
248258
</dt>
249259
<dd>
250-
The URL used in any hyperlink present in the <em>Credits</em> field. May be
251-
empty if <em>Credits</em> contains no hyperlink section.
260+
The URL used in any hyperlink present in the <em>Credits</em> field. Should
261+
be empty if <em>Credits</em> contains no hyperlink section.
252262
</dd>
253263
<dt>
254264
<em>Comments</em>
255265
</dt>
256266
<dd>
257-
Text string containing any additional comments about the snippet. May be
258-
empty. Ignored by versions of CodeSnip that recognise the <em>Extra</em>
259-
field unless the <em>Extra</em> field is empty.
267+
<div class="half-spaced">
268+
Text string containing any additional comments about the snippet. May be
269+
empty.
270+
</div>
271+
<div class="half-spaced">
272+
Ignored by versions of CodeSnip that recognise the <em>Extra</em> field
273+
unless the <em>Extra</em> field is empty.
274+
</div>
260275
</dd>
261276
<dt>
262277
<em>DelphiXXX</em> &amp; <em>FPC</em>
@@ -346,12 +361,15 @@ <h3>
346361
</li>
347362
</ul>
348363
<div class="half-spaced">
349-
If not present, the compile results is assumed to be &quot;Q&quot;
364+
If not present, the compile result is assumed to be &quot;Q&quot;
350365
</div>
351366
<div class="half-spaced">
352367
From CodeSnip v3.8.9 a compile result of &quot;W&quot; is treated as if it
353368
were &quot;Y&quot;.
354369
</div>
370+
<div class="half-spaced">
371+
Any compiler not recognised by a given version of CodeSnip is ignored.
372+
</div>
355373
</dd>
356374
<dt>
357375
<em>Extra</em>
@@ -361,20 +379,23 @@ <h3>
361379
Provides extra information about the snippet. Can be empty or be a string
362380
of <acronym
363381
title="REML is decribed in the program's help file"
364-
>REML</acronym> code. This value was supported from CodeSnip v2.2.5.
382+
>REML</acronym> code.
365383
</div>
366384
<div class="half-spaced">
367-
If empty the extra information is generated from the <em>Comments</em> and
385+
If empty the extra information is generated from any <em>Comments</em> and
368386
<em>Credits</em> / <em>Credits_URL</em> values.
369387
</div>
388+
<div class="half-spaced">
389+
This value was supported from CodeSnip v2.2.5.
390+
</div>
370391
</dd>
371392
<dt>
372393
<em>StandardFormat</em>
373394
</dt>
374395
<dd>
375396
<div class="half-spaced">
376-
Flag indicating if a snippet is in &quot;standard format&quot;. This value
377-
was supported from CodeSnip v2.0. Valid values are:
397+
Flag indicating if a snippet is in &quot;standard format&quot;. Valid
398+
values are:
378399
</div>
379400
<ul class="unspaced">
380401
<li>
@@ -387,6 +408,9 @@ <h3>
387408
<div class="half-spaced">
388409
If not present then <em>StandardFormat</em> = &quot;1&quot; is assumed.
389410
</div>
411+
<div class="half-spaced">
412+
This value was supported from CodeSnip v2.0.
413+
</div>
390414
<div class="half-spaced">
391415
From CodeSnip v3.0 <em>StandardFormat</em> is ignored if the <em>Kind</em>
392416
value is present. If <em>Kind</em> is not present then
@@ -400,8 +424,7 @@ <h3>
400424
</dt>
401425
<dd>
402426
<div class="half-spaced">
403-
Kind of code snippet. This value was supported from CodeSnip v3.0. Valid
404-
values are:
427+
Kind of code snippet. Valid values are:
405428
</div>
406429
<ul class="unspaced">
407430
<li>
@@ -433,14 +456,16 @@ <h3>
433456
<em>StandardFormat</em> are present then <em>Kind</em> defaults to
434457
&quot;routine&quot;.
435458
</div>
459+
<div class="half-spaced">
460+
This value was supported from CodeSnip v3.0.
461+
</div>
436462
</dd>
437463
<dt>
438464
<em>TestInfo</em>
439465
</dt>
440466
<dd>
441467
<div class="half-spaced">
442-
Testing information for snippets. This value was supported from CodeSnip
443-
v4.0. Valid values are:
468+
Testing information for snippets. Valid values are:
444469
</div>
445470
<ul class="unspaced">
446471
<li>
@@ -459,30 +484,20 @@ <h3>
459484
&quot;basic&quot;. This is because, until the release of CodeSnip v4.0,
460485
all snippets had undergone at least basic testing.
461486
</div>
487+
<div class="half-spaced">
488+
This value was supported from CodeSnip v4.0.
489+
</div>
462490
</dd>
463491
<dt>
464492
<em>MinVer</em>
465493
</dt>
466494
<dd>
467-
<div class="pullout">
468-
Used only by the online database and ignored by the CodeSnip program.
469-
</div>
470-
<div class="half-spaced">
471-
Minimum program version or equivalent on which this snippet can be
472-
included in a generated unit.
473-
</div>
474495
<div class="half-spaced">
475-
<em>MinVer</em>'s value is a dotted quad representing a program version
476-
number where any omitted numbers are treated as zeros (e.g. 1, 1.0, 1.0.0
477-
and 1.0.0.0 are all eqivalent).
496+
Ignored.
478497
</div>
479498
<div class="half-spaced">
480-
The online database uses this value so that it can display snippets that
481-
it doesn't know how to include in units. The online database adopts an
482-
equivalent version number to the CodeSnip release with similar qualities
483-
and tests that against <em>MinVer</em>. If <em>MinVer</em> is greater than
484-
the database's assumed version number, the snippet can't be included in
485-
a generated unit.
499+
This value was used by a now defunct version of the online Code Snippets
500+
Database, but is no longer used.
486501
</div>
487502
</dd>
488503
</dl>
@@ -570,10 +585,10 @@ <h4>
570585
and <em>if-ver-lte</em> have never worked correctly: they have always been
571586
interpreted as <em>if-ver-gt</em> and <em>if-ver-lt</em> respectively. A fix
572587
to this could now cause more problems than it solves in older version of
573-
<em>CodeSnip</em>, so the implementation of the directives has been removed
574-
from later versions of the program and all occurrences of the directives in
575-
the database have been replaced by suitable <em>if-ver-inrange</em>
576-
directives.
588+
<em>CodeSnip</em>, so the implementation of the problematic directives has
589+
been removed from later versions of the program and all occurrences of the
590+
directives in the database have been replaced by suitable
591+
<em>if-ver-inrange</em> directives.
577592
</p>
578593

579594
<p>
@@ -655,7 +670,7 @@ <h4>
655670
Finally, it is possible that a <code>name.3.ini</code> or
656671
<code>name.4.ini</code> file will exist with no matching
657672
<code>name.ini</code>. In this case <code>categories.ini</code> (or
658-
<code>categories.3.ini</code> must still refer to <code>name.ini</code>, not
673+
<code>categories.3.ini</code>) must still refer to <code>name.ini</code>, not
659674
<code>name.3.ini</code> or <code>name.4.ini</code>. The program works out
660675
which files to load.
661676
</p>
@@ -667,7 +682,7 @@ <h3>
667682
<p>
668683
Source code is stored separately from the category .ini files. Each snippet
669684
has its own uniquely named file. Files can have any name providing it doesn't
670-
clash with the master file name or the names of the category file. By
685+
clash with the master file name or the names of the category files. By
671686
convention, source code files are named numerically in sequence and have a
672687
.dat file extension. So <code>102.dat</code> is a typical source code file
673688
name. Sometimes there is a separate file for later versions of CodeSnip, so
@@ -694,8 +709,8 @@ <h3>
694709
</p>
695710

696711
<p>
697-
The credits file stand alone from the other files in the database in that they
698-
are not referenced by, and do not reference, any of the other files.
712+
The credits files stand alone from the other files in the database in that
713+
they are not referenced by, and do not reference, any of the other files.
699714
</p>
700715

701716
</body>

0 commit comments

Comments
 (0)