Skip to content

Commit 980b9de

Browse files
committed
Convert all Credits & Comments keys to Extra
Also merged Credits_URL and Credits keys to create required REML for Extra key. Fixes following bug: TimeZone bias bug in Desc key - see issue #6
1 parent 4c8032e commit 980b9de

16 files changed

+144
-164
lines changed

Diff for: csdb/collection/date.ini

+34-38
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
[AddDays]
99
DescEx="<p>Adds the number of days, <var>Days</var>, to the given date, <var>DateTime</var> and returns the result.</p><p>To subtract days, pass a negative value for <var>Days</var>.</p>"
10-
Credits="Contributed by Bill Miller."
10+
Extra="<p>Contributed by Bill Miller.</p>"
1111
SeeAlso=DiffDays
1212
Snip=548.dat
1313
Delphi2=Y
@@ -53,7 +53,7 @@ FPC=Y
5353

5454
[DateDay]
5555
Desc="Extracts the day of the month from a specified date."
56-
Credits="Adapted from code contributed by Bill Miller."
56+
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
5757
Units=SysUtils
5858
SeeAlso=DateMonth,DateYear,DayOfYear
5959
TestInfo=advanced
@@ -78,7 +78,7 @@ FPC=Y
7878

7979
[DateMonth]
8080
Desc="Extracts the month from a specified date."
81-
Credits="Adapted from code contributed by Bill Miller."
81+
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
8282
Units=SysUtils
8383
SeeAlso=DateDay,DateYear,DaysInMonth,DateMonthEnd,DateMonthStart
8484
Snip=225.dat
@@ -102,7 +102,7 @@ FPC=Y
102102

103103
[DateMonthEnd]
104104
Desc="Returns the last day of the month containing the given date."
105-
Comments="The date returned is midnight at the beginning of the last day of the month."
105+
Extra="<p>The date returned is midnight at the beginning of the last day of the month.</p>"
106106
Units=SysUtils
107107
SeeAlso=DateMonth,DateMonthStart,DaysInMonth
108108
Depends=DaysInMonth
@@ -128,8 +128,7 @@ FPC=Y
128128

129129
[DateMonthStart]
130130
Desc="Returns the first day of the month containing the given date."
131-
Credits="Slightly modified from code contributed by Bill Miller."
132-
Comments="The date returned is midnight at the beginning of the first day of the month."
131+
Extra="<p>The date returned is midnight at the beginning of the first day of the month.</p><p>Slightly modified from code contributed by Bill Miller.</p>"
133132
Units="SysUtils"
134133
SeeAlso=DateMonth,DateMonthEnd
135134
TestInfo=advanced
@@ -154,7 +153,7 @@ FPC=Y
154153

155154
[DateQuarter]
156155
Desc="Returns the number of the quarter containing a given date."
157-
Credits="Based on code contributed by Homolibere."
156+
Extra="<p>Based on code contributed by Homolibere.</p>"
158157
Units=SysUtils
159158
SeeAlso=DateQuarterStart,DateQuarterEnd
160159
TestInfo=advanced
@@ -179,7 +178,7 @@ FPC=Y
179178

180179
[DateQuarterEnd]
181180
Desc="Gets the date of the last day of the quarter containing a given date."
182-
Credits="Modified from code contributed by Homolibere."
181+
Extra="<p>Modified from code contributed by Homolibere.</p>"
183182
Units=SysUtils
184183
SeeAlso=DateQuarter,DateQuarterStart
185184
TestInfo=advanced
@@ -204,7 +203,7 @@ FPC=Y
204203

205204
[DateQuarterStart]
206205
Desc="Gets the date of the first day of the quarter containing a given date."
207-
Credits="Modified from code contributed by Homolibere."
206+
Extra="<p>Modified from code contributed by Homolibere.</p>"
208207
Units=SysUtils
209208
SeeAlso=DateQuarter,DateQuarterEnd
210209
TestInfo=advanced
@@ -274,7 +273,7 @@ FPC=Y
274273

275274
[DateYear]
276275
Desc="Extracts the year from a specified date."
277-
Credits="Adapted from code contributed by Bill Miller."
276+
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
278277
Units=SysUtils
279278
SeeAlso=DateDay,DateMonth,IsLeapYear,DateYearStart,DateYearEnd
280279
Snip=226.dat
@@ -298,8 +297,7 @@ FPC=Y
298297

299298
[DateYearEnd]
300299
Desc="Returns the last day of the year containing the specified date."
301-
Credits="Renamed routine from Bill Miller's snippets collection."
302-
Comments="The date returned is midnight at the beginning of the last day of the year."
300+
Extra="<p>The date returned is midnight at the beginning of the last day of the year.</p><p>Renamed routine from Bill Miller's snippets collection.</p>"
303301
Units=SysUtils
304302
SeeAlso=DateYear,DateYearStart
305303
TestInfo=advanced
@@ -324,8 +322,7 @@ FPC=Y
324322

325323
[DateYearStart]
326324
Desc="Returns the first day of the year containing the specified date."
327-
Credits="Renamed from routine contributed by Bill Miller."
328-
Comments="The date returned is midnight at the beginning of the first day of the year."
325+
Extra="<p>The date returned is midnight at the beginning of the first day of the year.</p><p>Renamed from routine contributed by Bill Miller.</p>"
329326
Units=SysUtils
330327
SeeAlso=DateYear,DateYearEnd
331328
TestInfo=advanced
@@ -350,7 +347,7 @@ FPC=Y
350347

351348
[DayOfYear]
352349
Desc="Returns the day of the year for the given date."
353-
Credits="From Bill Miller's snippets collection."
350+
Extra="<p>From Bill Miller's snippets collection.</p>"
354351
Depends=DateYearStart
355352
SeeAlso=DateDay
356353
Snip=550.dat
@@ -398,7 +395,7 @@ FPC=Y
398395

399396
[DiffDays]
400397
Desc="Returns the whole number of days separating two given dates."
401-
Credits="Contributed by Bill Miller."
398+
Extra="<p>Contributed by Bill Miller.</p>"
402399
SeeAlso=AddDays
403400
Snip=549.dat
404401
Delphi2=Y
@@ -421,7 +418,7 @@ FPC=Y
421418

422419
[Is24HourTimeFormat]
423420
Desc="Checks if the 24 hour time format is being used by the current thread."
424-
Credits="Contributed by Bill Miller."
421+
Extra="<p>Contributed by Bill Miller.</p>"
425422
Units=SysUtils,Windows
426423
Snip=229.dat
427424
Delphi2=Y
@@ -444,7 +441,7 @@ FPC=N
444441

445442
[IsDaylightSaving]
446443
Desc="Checks if current local time is daylight saving time."
447-
Comments="Raises exception if daylight saving information cannot be obtained from operating system."
444+
Extra="<p>Raises exception if daylight saving information cannot be obtained from operating system.</p>"
448445
Units=SysUtils,Windows
449446
Snip=230.dat
450447
Delphi2=N
@@ -467,7 +464,7 @@ FPC=Y
467464

468465
[IsFriday]
469466
Desc="Checks if the given date is a Friday."
470-
Credits="Contributed by Bill Miller."
467+
Extra="<p>Contributed by Bill Miller.</p>"
471468
SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsSaturday,IsSunday,IsWeekday,IsWeekend
472469
Units=SysUtils
473470
Snip=539.dat
@@ -491,7 +488,7 @@ FPC=Y
491488

492489
[IsLeapYear]
493490
Desc="Checks if a specified date falls in a leap year."
494-
Credits="Adapted from code contributed by Bill Miller."
491+
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
495492
Depends=DateYear
496493
SeeAlso=DateYear,DaysInMonth
497494
Snip=227.dat
@@ -515,7 +512,7 @@ FPC=Y
515512

516513
[IsMonday]
517514
Desc="Checks if the given date is a Monday."
518-
Credits="Contributed by Bill Miller."
515+
Extra="<p>Contributed by Bill Miller.</p>"
519516
SeeAlso=IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend
520517
Units=SysUtils
521518
Snip=540.dat
@@ -539,7 +536,7 @@ FPC=Y
539536

540537
[IsSaturday]
541538
Desc="Checks if the given date is a Saturday."
542-
Credits="Contributed by Bill Miller."
539+
Extra="<p>Contributed by Bill Miller.</p>"
543540
SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSunday,IsWeekday,IsWeekend
544541
Units=SysUtils
545542
Snip=541.dat
@@ -563,7 +560,7 @@ FPC=Y
563560

564561
[IsSunday]
565562
Desc="Checks if the given date is a Sunday."
566-
Credits="Contributed by Bill Miller."
563+
Extra="<p>Contributed by Bill Miller.</p>"
567564
SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsWeekday,IsWeekend
568565
Units=SysUtils
569566
Snip=542.dat
@@ -587,7 +584,7 @@ FPC=Y
587584

588585
[IsThursday]
589586
Desc="Checks if the given date is a Thursday."
590-
Credits="Contributed by Bill Miller."
587+
Extra="<p>Contributed by Bill Miller.</p>"
591588
SeeAlso=IsMonday,IsTuesday,IsWednesday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend
592589
Units=SysUtils
593590
Snip=543.dat
@@ -611,7 +608,7 @@ FPC=Y
611608

612609
[IsTuesday]
613610
Desc="Checks if the given date is a Tuesday."
614-
Credits="Contributed by Bill Miller."
611+
Extra="<p>Contributed by Bill Miller.</p>"
615612
SeeAlso=IsMonday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend
616613
Units=SysUtils
617614
Snip=544.dat
@@ -635,7 +632,7 @@ FPC=Y
635632

636633
[IsValidDate]
637634
Desc="Checks if a string represents a valid date in the current locale."
638-
Credits="Inspired by code from Bill Miller's snippets collection."
635+
Extra="<p>Inspired by code from Bill Miller's snippets collection.</p>"
639636
Units=SysUtils
640637
SeeAlso=IsValidTime
641638
Snip=355.dat
@@ -659,7 +656,7 @@ FPC=Y
659656

660657
[IsValidTime]
661658
Desc="Checks if a string represents a valid time in the current locale."
662-
Credits="Inspired by code from Bill Miller's snippets collection."
659+
Extra="<p>Inspired by code from Bill Miller's snippets collection.</p>"
663660
Units=SysUtils
664661
SeeAlso=IsValidDate
665662
Snip=356.dat
@@ -683,7 +680,7 @@ FPC=Y
683680

684681
[IsWednesday]
685682
Desc="Checks if the given date is a Wednesday."
686-
Credits="Contributed by Bill Miller."
683+
Extra="<p>Contributed by Bill Miller.</p>"
687684
SeeAlso=IsMonday,IsTuesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend
688685
Units=SysUtils
689686
Snip=545.dat
@@ -707,7 +704,7 @@ FPC=Y
707704

708705
[IsWeekday]
709706
Desc="Checks if the given date is a weekday."
710-
Credits="Contributed by Bill Miller."
707+
Extra="<p>Contributed by Bill Miller.</p>"
711708
SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekend
712709
Units=SysUtils
713710
Snip=546.dat
@@ -731,7 +728,7 @@ FPC=Y
731728

732729
[IsWeekend]
733730
Desc="Checks if the given date is a weekend."
734-
Credits="Contributed by Bill Miller."
731+
Extra="<p>Contributed by Bill Miller.</p>"
735732
SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday
736733
Units=SysUtils
737734
Snip=547.dat
@@ -801,7 +798,7 @@ FPC=Y
801798

802799
[SQLDateToDateTime]
803800
DescEx="Converts a date in SQL format into a <var>TDateTime</var>."
804-
Comments="Handles only the date component. Any time component is ignored."
801+
Extra="<p>Handles only the date component. Any time component is ignored.</p>"
805802
Units=SysUtils
806803
SeeAlso=SQLDate
807804
TestInfo=advanced
@@ -826,7 +823,7 @@ FPC=Y
826823

827824
[TimeHour]
828825
Desc="Extracts the hour from a specified time."
829-
Credits="Adapted from code contributed by Bill Miller."
826+
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
830827
Units=SysUtils
831828
SeeAlso=TimeMin,TimeSec
832829
Snip=175.dat
@@ -850,7 +847,7 @@ FPC=Y
850847

851848
[TimeMin]
852849
Desc="Extracts the minute from a specified time."
853-
Credits="Adapted from code contributed by Bill Miller."
850+
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
854851
Units=SysUtils
855852
SeeAlso=TimeHour,TimeSec
856853
Snip=176.dat
@@ -874,7 +871,7 @@ FPC=Y
874871

875872
[TimeSec]
876873
Desc="Extracts the second from a specified time."
877-
Credits="Adapted from code contributed by Bill Miller."
874+
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
878875
Units=SysUtils
879876
SeeAlso=TimeHour,TimeMin
880877
Snip=177.dat
@@ -897,9 +894,8 @@ Delphi10S=Y
897894
FPC=Y
898895

899896
[TimeZoneBias]
900-
Desc="Gets the bias of the local time zone relative to UTC (GMT). Does not adjust for daylight saving time."
901-
Desc="<p>Gets the bias of the local time zone relative to UTC (GMT).</p><p>Does not adjust for daylight saving time.</p>"
902-
Credits="Adapted from code contributed by Bill Miller."
897+
DescEx="<p>Gets the bias of the local time zone relative to UTC (GMT).</p><p>Does not adjust for daylight saving time.</p>"
898+
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
903899
Units=SysUtils,Windows
904900
SeeAlso=AdjustedTimeZoneBias,TimeZoneName
905901
Snip=270.dat
@@ -923,7 +919,7 @@ FPC=Y
923919

924920
[TimeZoneName]
925921
Desc="Returns a string containing the local time zone name or '' if the name is unknown."
926-
Credits="Adapted from code contributed by Bill Miller."
922+
Extra="<p>Adapted from code contributed by Bill Miller.</p>"
927923
Units=SysUtils,Windows
928924
SeeAlso=TimeZoneBias
929925
Snip=271.dat

Diff for: csdb/collection/drive.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
[CurentDrive]
99
Desc="Returns the letter that identifies the current drive."
10-
Credits="Modified from Bill Miller's snippets collection."
10+
Extra="<p>Modified from Bill Miller's snippets collection.</p>"
1111
Snip=352.dat
1212
Delphi2=Y
1313
Delphi3=Y

Diff for: csdb/collection/encoding.ini

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
[BytesToAnsiString]
99
DescEx="Converts the given array of bytes to an ANSI raw byte string, which is returned. The returned string has the code page specified by <var>CodePage</var>."
10-
Credits="Based on code from the Stack Overflow posting [How can I convert TBytes to RawByteString?]."
11-
Credits_URL="http://stackoverflow.com/questions/773297/how-can-i-convert-tbytes-to-rawbytestring"
10+
Extra="<p>Based on code from the Stack Overflow posting <a href="http://stackoverflow.com/questions/773297/how-can-i-convert-tbytes-to-rawbytestring">How can I convert TBytes to RawByteString?</a>.</p>"
1211
Units=SysUtils
1312
Snip=359.dat
1413
Delphi2=N

Diff for: csdb/collection/file.ini

+8-11
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ FPC=Y
3030

3131
[CopyFiles]
3232
DescEx="<p>Copies files from directory name <var>SrcDir</var> to directory named <var>DestDir</var>. Files to be copied are filtered using DOS wildcard mask in <var>WildCard</var>.</p><p>Sub-directories are not copied. <var>DestDir</var> must exist.</p>"
33-
Credits="Contributed by Jan Roza."
33+
Extra="<p>Contributed by Jan Roza.</p>"
3434
Units=Classes,SysUtils,Windows
3535
Depends=ListFiles,DirToPath
3636
SeeAlso=CopyFile
@@ -124,7 +124,7 @@ FPC=Y
124124

125125
[DeleteFilesWithUndo]
126126
Desc="Deletes a list of files and sends them all to the recycle bin. Returns True if the files were deleted successfully and False if the function fails."
127-
Comments="If any of the listed files don't exist none will be deleted and the function will fail."
127+
Extra="<p>If any of the listed files don't exist none will be deleted and the function will fail.</p>"
128128
Units=Classes,ShellAPI
129129
Depends=StringsToMultiSz
130130
SeeAlso=EmptyRecycleBin,DeleteFiles,DeleteFileWithUndo
@@ -240,7 +240,7 @@ FPC=Y
240240

241241
[FileSizeString]
242242
Desc="Returns the size of a file as a formatted string. For files larger than 1Kb the size is approximate. If the file size can't be read then the empty string is returned."
243-
Credits="Modification of code contributed by Michael Rockett."
243+
Extra="<p>Modification of code contributed by Michael Rockett.</p>"
244244
Units=SysUtils
245245
Depends=SizeOfFile64
246246
Snip=407.dat
@@ -333,7 +333,7 @@ FPC=Y
333333

334334
[GetLastDirectory]
335335
Desc="Returns the last directory in a specified path or the empty string if the given path is not a directory."
336-
Credits="Modified from code contributed by Bill Miller."
336+
Extra="<p>Modified from code contributed by Bill Miller.</p>"
337337
Units=SysUtils
338338
Depends=IsDirectory,PathToDir
339339
Snip=408.dat
@@ -546,8 +546,7 @@ FPC=Y
546546

547547
[IsValidFileName]
548548
Desc="Tests if a file name is a valid on Windows file systems."
549-
Credits="Based on information contained in the [File Names, Paths and Namespaces] topic on the Microsoft Developer Network."
550-
Credits_URL="http://msdn.microsoft.com/en-us/library/aa365247.aspx"
549+
Extra="<p>Based on information contained in the <a href="http://msdn.microsoft.com/en-us/library/aa365247.aspx">File Names, Paths and Namespaces</a> topic on the Microsoft Developer Network.</p>"
551550
Units=SysUtils
552551
Depends=SizeOfFile64
553552
Snip=260.dat
@@ -618,8 +617,7 @@ FPC=Y
618617

619618
[PathIsRoot]
620619
Desc="Checks if the given path is a root directory."
621-
Credits="Slightly modified from code created by Steve Moss, CoCo Systems Ltd. Contributed by Bill Miller."
622-
Comments="Works with UNC paths and paths with drive specifiers."
620+
Extra="<p>Works with UNC paths and paths with drive specifiers.</p><p>Slightly modified from code created by Steve Moss, CoCo Systems Ltd. Contributed by Bill Miller.</p>"
623621
Units=SysUtils
624622
Depends=DirToPath
625623
Snip=354.dat
@@ -711,7 +709,7 @@ FPC=Y
711709

712710
[SizeOfFile64]
713711
Desc="Gets the size of a file. Returns -1 if the file doesn't exist or can't be accessed."
714-
Comments="Works with files larger than 2Gb."
712+
Extra="<p>Works with files larger than 2Gb.</p>"
715713
Units=SysUtils,Windows
716714
SeeAlso=SizeOfFile
717715
Snip=257.dat
@@ -757,8 +755,7 @@ FPC=Y
757755

758756
[URLFromShortcut]
759757
Desc="Returns the URL referenced by the given URL shortcut file, or the empty string if the given file is not a shortcut file."
760-
Credits="Derived from a similar function published on [Torry's Delphi Pages]."
761-
Credits_URL="http://www.torry.net/"
758+
Extra="<p>Derived from a similar function published on <a href="http://www.torry.net/">Torry's Delphi Pages</a>.</p>"
762759
Units=IniFiles
763760
SeeAlso=CreateURLShortcut,IsURLShortcut
764761
Snip=045.dat

0 commit comments

Comments
 (0)