75
75
</ h2 >
76
76
77
77
< 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
79
79
files, using UTF-8 encoding. Files are saved with the UTF-8 preamble (BOM).
80
80
</ p >
81
81
@@ -173,11 +173,16 @@ <h3>
173
173
< em > DisplayName</ em >
174
174
</ dt >
175
175
< 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 >
181
186
</ dd >
182
187
< dt >
183
188
< em > Desc</ em >
@@ -190,11 +195,16 @@ <h3>
190
195
< em > DescEx</ em >
191
196
</ dt >
192
197
< 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 >
198
208
</ dd >
199
209
< dt >
200
210
< em > Snip</ em >
@@ -247,16 +257,21 @@ <h3>
247
257
< em > Credits_URL</ em >
248
258
</ dt >
249
259
< 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.
252
262
</ dd >
253
263
< dt >
254
264
< em > Comments</ em >
255
265
</ dt >
256
266
< 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 >
260
275
</ dd >
261
276
< dt >
262
277
< em > DelphiXXX</ em > & < em > FPC</ em >
@@ -346,12 +361,15 @@ <h3>
346
361
</ li >
347
362
</ ul >
348
363
< div class ="half-spaced ">
349
- If not present, the compile results is assumed to be "Q"
364
+ If not present, the compile result is assumed to be "Q"
350
365
</ div >
351
366
< div class ="half-spaced ">
352
367
From CodeSnip v3.8.9 a compile result of "W" is treated as if it
353
368
were "Y".
354
369
</ div >
370
+ < div class ="half-spaced ">
371
+ Any compiler not recognised by a given version of CodeSnip is ignored.
372
+ </ div >
355
373
</ dd >
356
374
< dt >
357
375
< em > Extra</ em >
@@ -361,20 +379,23 @@ <h3>
361
379
Provides extra information about the snippet. Can be empty or be a string
362
380
of < acronym
363
381
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.
365
383
</ div >
366
384
< 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
368
386
< em > Credits</ em > / < em > Credits_URL</ em > values.
369
387
</ div >
388
+ < div class ="half-spaced ">
389
+ This value was supported from CodeSnip v2.2.5.
390
+ </ div >
370
391
</ dd >
371
392
< dt >
372
393
< em > StandardFormat</ em >
373
394
</ dt >
374
395
< dd >
375
396
< div class ="half-spaced ">
376
- Flag indicating if a snippet is in "standard format". This value
377
- was supported from CodeSnip v2.0. Valid values are:
397
+ Flag indicating if a snippet is in "standard format". Valid
398
+ values are:
378
399
</ div >
379
400
< ul class ="unspaced ">
380
401
< li >
387
408
< div class ="half-spaced ">
388
409
If not present then < em > StandardFormat</ em > = "1" is assumed.
389
410
</ div >
411
+ < div class ="half-spaced ">
412
+ This value was supported from CodeSnip v2.0.
413
+ </ div >
390
414
< div class ="half-spaced ">
391
415
From CodeSnip v3.0 < em > StandardFormat</ em > is ignored if the < em > Kind</ em >
392
416
value is present. If < em > Kind</ em > is not present then
400
424
</ dt >
401
425
< dd >
402
426
< 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:
405
428
</ div >
406
429
< ul class ="unspaced ">
407
430
< li >
@@ -433,14 +456,16 @@ <h3>
433
456
< em > StandardFormat</ em > are present then < em > Kind</ em > defaults to
434
457
"routine".
435
458
</ div >
459
+ < div class ="half-spaced ">
460
+ This value was supported from CodeSnip v3.0.
461
+ </ div >
436
462
</ dd >
437
463
< dt >
438
464
< em > TestInfo</ em >
439
465
</ dt >
440
466
< dd >
441
467
< 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:
444
469
</ div >
445
470
< ul class ="unspaced ">
446
471
< li >
@@ -459,30 +484,20 @@ <h3>
459
484
"basic". This is because, until the release of CodeSnip v4.0,
460
485
all snippets had undergone at least basic testing.
461
486
</ div >
487
+ < div class ="half-spaced ">
488
+ This value was supported from CodeSnip v4.0.
489
+ </ div >
462
490
</ dd >
463
491
< dt >
464
492
< em > MinVer</ em >
465
493
</ dt >
466
494
< 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 >
474
495
< 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.
478
497
</ div >
479
498
< 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.
486
501
</ div >
487
502
</ dd >
488
503
</ dl >
@@ -570,10 +585,10 @@ <h4>
570
585
and < em > if-ver-lte</ em > have never worked correctly: they have always been
571
586
interpreted as < em > if-ver-gt</ em > and < em > if-ver-lt</ em > respectively. A fix
572
587
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.
577
592
</ p >
578
593
579
594
< p >
655
670
Finally, it is possible that a < code > name.3.ini</ code > or
656
671
< code > name.4.ini</ code > file will exist with no matching
657
672
< 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
659
674
< code > name.3.ini</ code > or < code > name.4.ini</ code > . The program works out
660
675
which files to load.
661
676
</ p >
667
682
< p >
668
683
Source code is stored separately from the category .ini files. Each snippet
669
684
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
671
686
convention, source code files are named numerically in sequence and have a
672
687
.dat file extension. So < code > 102.dat</ code > is a typical source code file
673
688
name. Sometimes there is a separate file for later versions of CodeSnip, so
694
709
</ p >
695
710
696
711
< 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.
699
714
</ p >
700
715
701
716
</ body >
0 commit comments