You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/collection-format.html
+15-15Lines changed: 15 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -147,7 +147,7 @@ <h2>
147
147
</dt>
148
148
<dd>
149
149
<p>
150
-
The name of the <code>.ini</code> file that contains information about each snippet in the category. <spanclass="very-strong">Must</span> be a valid file name, without path. The files <spanclass="very-strong">must</span> be stored in the same directory as <code>category.ini</code>.
150
+
The name of the <code>.ini</code> file that contains information about each snippet in the category. <spanclass="very-strong">Must</span> be a valid file name, without path. The files <spanclass="very-strong">must</span> be stored in the same directory as <code>category.ini</code> and <spanclass="very-strong">must</span> be unique within the collection.
151
151
</p>
152
152
</dd>
153
153
</dl>
@@ -213,15 +213,15 @@ <h2 id="category-ini">
213
213
</p>
214
214
</aside>
215
215
<p>
216
-
The sections in these files are named with identifiers that uniquely identify a snippet. This <spanclass="very-strong">must</span> be a valid Unicode Pascal identifier. The keys in a section have the following purpose:
216
+
The <codeclass="key">[snippet-name]</code>sections in these files <spanclass="very-strong">must</span> be named with identifiers that uniquely identify a snippet. This <spanclass="very-strong">must</span> be a valid Unicode Pascal identifier. The keys in each section have the following purpose:
217
217
</p>
218
218
<dl>
219
219
<dt>
220
220
<codeclass="key">DisplayName</code>
221
221
</dt>
222
222
<dd>
223
223
<p>
224
-
The human readable name of the snippet. May be any text of up to 64 characters.
224
+
The human readable name of the snippet. May be any plain text of up to 64 characters.
225
225
</p>
226
226
<p>
227
227
May be omitted. If not present then the snippet identifier that names the section is used as the human readable name.
@@ -334,7 +334,7 @@ <h2 id="category-ini">
334
334
</dt>
335
335
<dd>
336
336
<p>
337
-
Text that notes any credits / acknowledgements. <codeclass="key">Credits</code> may optionally contain one (and only one) section of text delimited by <code>[</code> and <code>]</code> characters that indicate the presence of a hyperlink. The enclosed text is used as the text of a hyperlink whose URL <spanclass="very-strong">must</span> be specified in the <codeclass="key">Credits_URL</code> key.
337
+
Text that notes any credits / acknowledgements. <codeclass="key">Credits</code> may optionally contain one (and only one) section of plain text delimited by <code>[</code> and <code>]</code> characters that indicate the presence of a hyperlink. The enclosed text is used as the text of a hyperlink whose URL <spanclass="very-strong">must</span> be specified in the <codeclass="key">Credits_URL</code> key.
338
338
</p>
339
339
<p>
340
340
<strong>[~>2.0.0]:</strong> May be omitted or empty. <codeclass="key">Credits</code> is ignored if a non-empty <codeclass="key">Extra</code> key is present.
@@ -362,7 +362,7 @@ <h2 id="category-ini">
362
362
</dt>
363
363
<dd>
364
364
<p>
365
-
Text string containing any additional comments about the snippet.
365
+
Plain text string containing any additional comments about the snippet.
366
366
</p>
367
367
<p>
368
368
Optional. Ignored if a non-empty <codeclass="key">Extra</code> key is present.
@@ -379,7 +379,7 @@ <h2 id="category-ini">
379
379
</dt>
380
380
<dd>
381
381
<p>
382
-
This related group of keys describe the results of compiling the snippet with various compilers. The key name identifies the compiler. Valid key names are:
382
+
This related group of keys describes the results of compiling the snippet with various compilers. The key name identifies the compiler. Valid key names are:
The kind (or type) of this code snippet. Valid values are:
432
432
</p>
433
433
<ulclass="unspaced">
434
-
<li><codeclass="value">freeform</code><sup><ahref="#footnote-3">3</a></sup> – a freeform snippet that doesn't conform to any other other supported type.</li>
434
+
<li><codeclass="value">freeform</code><sup><ahref="#footnote-3">3</a></sup> – a freeform snippet that doesn't conform to any other supported type.</li>
435
435
<li><codeclass="value">routine</code> – a Pascal routine (function or procedure).</li>
436
436
<li><codeclass="value">type</code> – a simple Pascal type definition.</li>
437
437
<li><codeclass="value">const</code> – a Pascal constant definition.</li>
@@ -447,7 +447,7 @@ <h2 id="category-ini">
447
447
</dt>
448
448
<dd>
449
449
<p>
450
-
Testing information for the snippet. Valid values are:
450
+
Information about if or how the snippet has been tested. Valid values are:
451
451
</p>
452
452
<ulclass="unspaced">
453
453
<li><codeclass="value">none</code> – the snippet has not been tested.</li>
@@ -515,7 +515,7 @@ <h1>
515
515
</h1>
516
516
517
517
<p>
518
-
There is a separate source code file for each snippet. These file names<spanclass="very-strong">must</span> be named exactly as specified in the related category <code>.ini</code> file's <codeclass="key">Snip</code> key. They are usually numbered from <code>001</code> and have a <code>.dat</code> extension, but this is not a requirement.
518
+
There is a separate source code file for each snippet. These files<spanclass="very-strong">must</span> be named exactly as specified in the related category <code>.ini</code> file's <codeclass="key">Snip</code> key. They are usually numbered from <code>001</code> and have a <code>.dat</code> extension, but this is not a requirement.
519
519
</p>
520
520
521
521
<p>
@@ -712,7 +712,7 @@ <h1>
712
712
</h1>
713
713
714
714
<p>
715
-
This is a file named <code>VERSION</code> that contains the version number of the collection, terminated by <code>CR+LF</code>. The version number <spanclass="very-strong">must</span> be of the form <codeclass="value">9.9.9</code>, where each <codeclass="value">9</code> represents a non-negative integer. The file is <spanclass="very-strong">required</span> and <spanclass="very-strong">must</span> be non-empty.
715
+
This is a file named <code>VERSION</code> that contains the version number of the collection, terminated by <code>CR+LF</code>. The version number <spanclass="very-strong">must</span> be of the form <codeclass="value">9.9.9</code>, where each <codeclass="value">9</code> represents a non-negative integer. The file is <spanclass="very-strong">required</span> and <spanclass="very-strong">must not</span> be empty.
In v2.0.x, both <codeclass="key">Desc</code> and <codeclass="key">DescEx</code> keys can be found together or individually. Deal with them as follows:
767
+
In ~>v2.0.0, both <codeclass="key">Desc</code> and <codeclass="key">DescEx</code> keys can be found together or individually. Deal with them as follows:
In version 2.0.x, various combinations of the above keys can be found. Deal with them as follows:
791
+
For ~>2.0.0 various combinations of the above keys can be found. Deal with them as follows:
792
792
</p>
793
793
794
794
<ul>
795
795
<li>
796
796
<p>
797
-
If a non-empty <codeclass="key">Extra</code> key exists simply use the REML<sup><ahref="#footnote-1">1</a></sup> code it defines and ignore and<codeclass="key">Credits</code>, <codeclass="key">Credits_URL</code> and <codeclass="key">Comments</code> values.
797
+
If a non-empty <codeclass="key">Extra</code> key exists simply use the REML<sup><ahref="#footnote-1">1</a></sup> code it defines and ignore any<codeclass="key">Credits</code>, <codeclass="key">Credits_URL</code> and <codeclass="key">Comments</code> values.
For ~>2.1 you can expect that <codeclass="key">Credits</code>, <codeclass="key">Credits_URL</code> or <codeclass="key">Comments</code> won't exist and simply deal with <codeclass="key">Extra</code> if it present.
825
+
For ~>2.1 you can expect that <codeclass="key">Credits</code>, <codeclass="key">Credits_URL</code> or <codeclass="key">Comments</code> won't exist and simply deal with <codeclass="key">Extra</code> if it is present.
826
826
</p>
827
827
828
828
<h2>
@@ -858,7 +858,7 @@ <h2>
858
858
</p>
859
859
860
860
<p>
861
-
Having <codeclass="key">AdvancedTest.Level</code> set to any other value provides additional information. In these cases <codeclass="key">AdvancedTest.URL</code> may provide a URL that links to code containing the tests. This could be a source code repository or a Gist, for example. Given that <codeclass="key">AdvancedTest.URL</code> is optional, software should be able to handle cases where there is no link to the test code available.
861
+
Having <codeclass="key">AdvancedTest.Level</code> set to any value other than <codeclass="key">unspecified</code> provides additional information. In these cases <codeclass="key">AdvancedTest.URL</code> may provide a URL that links to code containing the tests. This could be a source code repository or a Gist, for example. Given that <codeclass="key">AdvancedTest.URL</code> is optional, software should be able to handle cases where there is no link to the test code available.
Copy file name to clipboardExpand all lines: docs/source-code-format.html
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -147,7 +147,7 @@ <h1>
147
147
Routine snippets may refer to other routine, <ahref="#type">simple type</a>, <ahref="#class">class & advanced record</a> or <ahref="#const">constant</a> snippets.<sup><ahref="#footnote-1">†</a></sup>
148
148
</p>
149
149
<p>
150
-
Routines may be marked as overloaded by using the <strong>overload</strong> directive. However, it is necessary to ensure there is at least one other routine in the collection with the same name.
150
+
Routines may be marked as overloaded by using the <strong>overload</strong> directive. However, it is then necessary to ensure there is at least one other routine in the collection with the same name.
151
151
</p>
152
152
153
153
</section>
@@ -159,7 +159,7 @@ <h1>
159
159
</h1>
160
160
161
161
<p>
162
-
A simple type definition snippet, unsurprisingly, defines one or more Pascal types. Only simple types are supported. Classes, objects and records that contain methods are not supported: use <ahref="#class">class & advanced record</a> snippet kinds for those. If you're not sure, the only types supported are those that can be completely defined in the interface section of a Pascal unit.
162
+
A simple type definition snippet defines one or more Pascal types. Only simple types are supported. Classes, objects and records that contain methods are not supported: use <ahref="#class">class & advanced record</a> snippet kinds for those. If you're not sure, the only types supported are those that can be completely defined in the interface section of a Pascal unit.
163
163
</p>
164
164
<p>
165
165
Source code files <strongclass="very-strong">must</strong> begin with the <strong>type</strong> keyword, followed by at least one space or a new line and then one or more type definitions.
0 commit comments