Skip to content

Commit 17ea8f3

Browse files
committed
Minor corrections & edits to collection docs
1 parent 7ed2037 commit 17ea8f3

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

docs/collection-format.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ <h2>
147147
</dt>
148148
<dd>
149149
<p>
150-
The name of the <code>.ini</code> file that contains information about each snippet in the category. <span class="very-strong">Must</span> be a valid file name, without path. The files <span class="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. <span class="very-strong">Must</span> be a valid file name, without path. The files <span class="very-strong">must</span> be stored in the same directory as <code>category.ini</code> and <span class="very-strong">must</span> be unique within the collection.
151151
</p>
152152
</dd>
153153
</dl>
@@ -213,15 +213,15 @@ <h2 id="category-ini">
213213
</p>
214214
</aside>
215215
<p>
216-
The sections in these files are named with identifiers that uniquely identify a snippet. This <span class="very-strong">must</span> be a valid Unicode Pascal identifier. The keys in a section have the following purpose:
216+
The <code class="key">[snippet-name]</code> sections in these files <span class="very-strong">must</span> be named with identifiers that uniquely identify a snippet. This <span class="very-strong">must</span> be a valid Unicode Pascal identifier. The keys in each section have the following purpose:
217217
</p>
218218
<dl>
219219
<dt>
220220
<code class="key">DisplayName</code>
221221
</dt>
222222
<dd>
223223
<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.
225225
</p>
226226
<p>
227227
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">
334334
</dt>
335335
<dd>
336336
<p>
337-
Text that notes any credits / acknowledgements. <code class="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 <span class="very-strong">must</span> be specified in the <code class="key">Credits_URL</code> key.
337+
Text that notes any credits / acknowledgements. <code class="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 <span class="very-strong">must</span> be specified in the <code class="key">Credits_URL</code> key.
338338
</p>
339339
<p>
340340
<strong>[~>2.0.0]:</strong> May be omitted or empty. <code class="key">Credits</code> is ignored if a non-empty <code class="key">Extra</code> key is present.
@@ -362,7 +362,7 @@ <h2 id="category-ini">
362362
</dt>
363363
<dd>
364364
<p>
365-
Text string containing any additional comments about the snippet.
365+
Plain text string containing any additional comments about the snippet.
366366
</p>
367367
<p>
368368
Optional. Ignored if a non-empty <code class="key">Extra</code> key is present.
@@ -379,7 +379,7 @@ <h2 id="category-ini">
379379
</dt>
380380
<dd>
381381
<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:
383383
</p>
384384
<ul class="unspaced">
385385
<li><code class="key">Delphi2</code> – Delphi 2 compiler</li>
@@ -431,7 +431,7 @@ <h2 id="category-ini">
431431
The kind (or type) of this code snippet. Valid values are:
432432
</p>
433433
<ul class="unspaced">
434-
<li><code class="value">freeform</code><sup><a href="#footnote-3">3</a></sup> – a freeform snippet that doesn't conform to any other other supported type.</li>
434+
<li><code class="value">freeform</code><sup><a href="#footnote-3">3</a></sup> – a freeform snippet that doesn't conform to any other supported type.</li>
435435
<li><code class="value">routine</code> – a Pascal routine (function or procedure).</li>
436436
<li><code class="value">type</code> – a simple Pascal type definition.</li>
437437
<li><code class="value">const</code> – a Pascal constant definition.</li>
@@ -447,7 +447,7 @@ <h2 id="category-ini">
447447
</dt>
448448
<dd>
449449
<p>
450-
Testing information for the snippet. Valid values are:
450+
Information about if or how the snippet has been tested. Valid values are:
451451
</p>
452452
<ul class="unspaced">
453453
<li><code class="value">none</code> – the snippet has not been tested.</li>
@@ -515,7 +515,7 @@ <h1>
515515
</h1>
516516

517517
<p>
518-
There is a separate source code file for each snippet. These file names <span class="very-strong">must</span> be named exactly as specified in the related category <code>.ini</code> file's <code class="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 <span class="very-strong">must</span> be named exactly as specified in the related category <code>.ini</code> file's <code class="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.
519519
</p>
520520

521521
<p>
@@ -712,7 +712,7 @@ <h1>
712712
</h1>
713713

714714
<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 <span class="very-strong">must</span> be of the form <code class="value">9.9.9</code>, where each <code class="value">9</code> represents a non-negative integer. The file is <span class="very-strong">required</span> and <span class="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 <span class="very-strong">must</span> be of the form <code class="value">9.9.9</code>, where each <code class="value">9</code> represents a non-negative integer. The file is <span class="very-strong">required</span> and <span class="very-strong">must not</span> be empty.
716716
</p>
717717

718718
<p>
@@ -764,7 +764,7 @@ <h3 id="implementing-desc-descex">
764764
</h3>
765765

766766
<p>
767-
In v2.0.x, both <code class="key">Desc</code> and <code class="key">DescEx</code> keys can be found together or individually. Deal with them as follows:
767+
In ~>v2.0.0, both <code class="key">Desc</code> and <code class="key">DescEx</code> keys can be found together or individually. Deal with them as follows:
768768
</p>
769769

770770
<ul>
@@ -788,13 +788,13 @@ <h3 id="generating-extra-from-credits-comments">
788788
</h3>
789789

790790
<p>
791-
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:
792792
</p>
793793

794794
<ul>
795795
<li>
796796
<p>
797-
If a non-empty <code class="key">Extra</code> key exists simply use the REML<sup><a href="#footnote-1">1</a></sup> code it defines and ignore and <code class="key">Credits</code>, <code class="key">Credits_URL</code> and <code class="key">Comments</code> values.
797+
If a non-empty <code class="key">Extra</code> key exists simply use the REML<sup><a href="#footnote-1">1</a></sup> code it defines and ignore any <code class="key">Credits</code>, <code class="key">Credits_URL</code> and <code class="key">Comments</code> values.
798798
</p>
799799
</li>
800800
<li>
@@ -822,7 +822,7 @@ <h3 id="generating-extra-from-credits-comments">
822822
</ul>
823823

824824
<p>
825-
For ~>2.1 you can expect that <code class="key">Credits</code>, <code class="key">Credits_URL</code> or <code class="key">Comments</code> won't exist and simply deal with <code class="key">Extra</code> if it present.
825+
For ~>2.1 you can expect that <code class="key">Credits</code>, <code class="key">Credits_URL</code> or <code class="key">Comments</code> won't exist and simply deal with <code class="key">Extra</code> if it is present.
826826
</p>
827827

828828
<h2>
@@ -858,7 +858,7 @@ <h2>
858858
</p>
859859

860860
<p>
861-
Having <code class="key">AdvancedTest.Level</code> set to any other value provides additional information. In these cases <code class="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 <code class="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 <code class="key">AdvancedTest.Level</code> set to any value other than <code class="key">unspecified</code> provides additional information. In these cases <code class="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 <code class="key">AdvancedTest.URL</code> is optional, software should be able to handle cases where there is no link to the test code available.
862862
</p>
863863

864864
</section>

docs/source-code-format.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ <h1>
147147
Routine snippets may refer to other routine, <a href="#type">simple type</a>, <a href="#class">class &amp; advanced record</a> or <a href="#const">constant</a> snippets.<sup><a href="#footnote-1">&dagger;</a></sup>
148148
</p>
149149
<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.
151151
</p>
152152

153153
</section>
@@ -159,7 +159,7 @@ <h1>
159159
</h1>
160160

161161
<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 <a href="#class">class &amp; 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 <a href="#class">class &amp; 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.
163163
</p>
164164
<p>
165165
Source code files <strong class="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

Comments
 (0)