Skip to content

Commit 9bb725e

Browse files
author
delphidabbler
committed
Edit and correct save snippet and save unit help topcs
1 parent 2c75da0 commit 9bb725e

File tree

2 files changed

+101
-31
lines changed

2 files changed

+101
-31
lines changed

‎Src/Help/HTML/dlg_savesnippet.htm

Lines changed: 50 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -65,34 +65,63 @@ <h1>
6565
</p>
6666
<ul>
6767
<li>
68-
A Pascal include file (.inc) - The code is written to a file with
69-
extension *.inc that can be included in any Pascal source file.
68+
A Pascal include file (.inc) &ndash; The code is written to a file with
69+
extension .inc that can be included in any Pascal source file. The file
70+
should be valid for inclusion in a Pascal unit using the
71+
<code>$INCLUDE</code> (or <code>$I</code>) directive.
7072
</li>
7173
<li>
72-
A plain text file (.txt) - This is the same as the Pascal include file
73-
except that the extension is .txt rather than .inc.
74+
A plain text file (.txt) &ndash; This is the same as the Pascal include
75+
file except that the extension is .txt rather than .inc.
7476
</li>
7577
<li>
76-
An HTML file (.html) - This option writes the source code out as a
77-
valid XHTML document that uses CSS to format the code. The document can
78-
be syntax highlighted if the <em>Use syntax highlighting</em>
79-
check box is checked.
78+
An HTML file (.html) &ndash; This option writes the source code out as a
79+
valid XHTML document that uses embedded CSS to format the code. The
80+
source code will be syntax highlighted if the <em>Use syntax
81+
highlighting</em> check box is checked.
8082
</li>
8183
<li>
82-
A rich text file (.rtf) - The source code is written out as an RTF
84+
A rich text file (.rtf) &ndash; The source code is written out as an RTF
8385
document. Again syntax highlighting can be used if the <em>Use syntax
8486
highlighting</em> check box is checked.
8587
</li>
8688
</ul>
8789
<p>
8890
Snippet descriptions can be written as a Pascal comment to the output
8991
file. Use the <em>Comment style</em> drop down list to specify the style
90-
of commenting to be used. Comments can be inhibited using by selecting the
91-
<em>No comments</em> option from the list. If the <em>Truncate comments to
92-
1st paragraph</em> check box is ticked then only the first paragraph of
93-
the snippet's description is used. Clearing this check box means that all
94-
of the description is used.
92+
of commenting to be used. Such comments can be inhibited by selecting the
93+
<em>No descriptive comments</em> option from the list. If the <em>Truncate
94+
comments to 1st paragraph</em> check box is ticked then only the first
95+
paragraph of the snippet's description is used. Clearing this check box
96+
means that the full text of the description is used.
9597
</p>
98+
<p>
99+
The output file encoding can be be specified in the <em>File Encoding</em>
100+
drop down list. Options vary depending on the file type. Some file types
101+
support only a single encoding. The encodings are:
102+
</p>
103+
<ul>
104+
<li>
105+
<em>ANSI (Default)</em> &ndash; the system default ANSI encoding.
106+
Available for both plain text and Pascal include files and as the only
107+
option for rich text files.
108+
</li>
109+
<li>
110+
<em>UTF-8</em> &ndash; UTF-8 encoding, with BOM<sup>&dagger;</sup>.
111+
Available for both plain text and Pascal include files and as the only
112+
option for XHTML files. If used for Pascal include files be warned that
113+
the files will only compile with compilers that support Unicode source
114+
files.
115+
</li>
116+
<li>
117+
<em>Unicode (Little Endian)</em> &ndash; UTF-16 LE encoding, with
118+
BOM<sup>&dagger;</sup>. Available for plain text files only.
119+
</li>
120+
<li>
121+
<em>Unicode (Big Endian)</em> &ndash; UTF-16 BE encoding, with
122+
BOM<sup>&dagger;</sup>. Available for plain text files only.
123+
</li>
124+
</ul>
96125
<p>
97126
The output can be previewed by clicking the <em>Preview</em> button. This
98127
displays the source code in a dialogue box, formatted according to your
@@ -103,6 +132,13 @@ <h1>
103132
Use the <em>Save</em> button to write the file to disk or press
104133
<em>Cancel</em> to abort.
105134
</p>
135+
<h3>
136+
Footnote
137+
</h3>
138+
<p>
139+
&dagger; BOM = Byte Order Mark or Preamble: a sequence of bytes at the
140+
start of a text file that identifies its encoding.
141+
</p>
106142
</body>
107143
</html>
108144

‎Src/Help/HTML/dlg_saveunit.htm

Lines changed: 51 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ <h1>
2929
<p>
3030
This dialogue box is displayed when the <em>File | Save Unit</em> menu
3131
option is clicked. It is used to specify the file name, file type and
32-
formatting information for the source code unit that is to be saved.
32+
formatting information for the unit that is to be saved.
3333
</p>
3434
<p>
3535
All currently selected snippets, with the exception of any
@@ -43,7 +43,7 @@ <h1>
4343
</p>
4444
<p>
4545
You specify the name and folder for the file where the unit will be saved
46-
in in the usual way. Note that the chosen file name, minus its extension
46+
in in the usual way. <strong class="warning">Warning:</strong> the chosen file name, minus its extension
4747
must be a valid Pascal unit name.
4848
</p>
4949
<p>
@@ -52,43 +52,77 @@ <h1>
5252
</p>
5353
<ul>
5454
<li>
55-
A Pascal unit file (.pas) - The code is written to a file with
55+
A Pascal unit file (.pas) &ndash; The code is written to a file with
5656
extension .pas. The unit is given a name based on the file name.
5757
</li>
5858
<li>
59-
A plain text file (.txt) - This is the same as the Pascal unit file
60-
except that the extension is .txt rather than .pas.
59+
A plain text file (.txt) &ndash; This is the same as the Pascal unit
60+
file except that the extension is .txt rather than .pas.
6161
</li>
6262
<li>
63-
An HTML file (.html) - This option writes the source code out as a
64-
valid XHTML document that uses CSS to format the code. The document can
65-
contain syntax highlighting if the <em>Use syntax highlighting</em>
66-
check box is checked.
63+
An HTML file (.html) &ndash; This option writes the source code out as a
64+
valid XHTML document that uses embedded CSS to format the code. The
65+
source code will be syntax highlighted if the <em>Use syntax
66+
highlighting</em> check box is checked.
6767
</li>
6868
<li>
69-
A rich text file (.rtf) - The source code is written out as an RTF
69+
A rich text file (.rtf) &ndash; The source code is written out as an RTF
7070
document. Again syntax highlighting can be used if the <em>Use syntax
7171
highlighting</em> check box is checked.
7272
</li>
7373
</ul>
7474
<p>
7575
Each snippet's description can be written as a Pascal comment to the
7676
output file. Use the <em>Comment style</em> drop down list to specify the
77-
style of commenting to be used. Comments can be inhibited using by
78-
selecting the <em>No comments</em> option from the list. If the
79-
<em>Truncate comments to 1st paragraph</em> check box is ticked then only
80-
the first paragraph of the snippet's description is used. Clearing this
81-
check box means that all of the description is used.
77+
style of commenting to be used. Such comments can be inhibited by
78+
selecting the <em>No descriptive comments</em> option from the list. If
79+
the <em>Truncate comments to 1st paragraph</em> check box is ticked then
80+
only the first paragraph of each snippet's description is used. Clearing
81+
this check box means that the full text of snippet descriptions are used.
8282
</p>
83+
<p>
84+
The output file encoding can be be specified in the <em>File Encoding</em>
85+
drop down list. Options vary depending on the file type. Some file types
86+
support only a single encoding. The encodings are:
87+
</p>
88+
<ul>
89+
<li>
90+
<em>ANSI (Default)</em> &ndash; the system default ANSI encoding.
91+
Available for both plain text and Pascal unit files and as the only
92+
option for rich text files.
93+
</li>
94+
<li>
95+
<em>UTF-8</em> &ndash; UTF-8 encoding, with BOM<sup>&dagger;</sup>.
96+
Available for both plain text and Pascal unit files and as the only
97+
option for XHTML files. If used for Pascal units be warned that the
98+
unit will only compile with compilers that support Unicode source
99+
files.
100+
</li>
101+
<li>
102+
<em>Unicode (Little Endian)</em> &ndash; UTF-16 LE encoding, with
103+
BOM<sup>&dagger;</sup>. Available for plain text files only.
104+
</li>
105+
<li>
106+
<em>Unicode (Big Endian)</em> &ndash; UTF-16 BE encoding, with
107+
BOM<sup>&dagger;</sup>. Available for plain text files only.
108+
</li>
109+
</ul>
83110
<p>
84111
The output can be previewed by clicking the <em>Preview</em> button. This
85112
displays the source code in a dialogue box, formatted according to your
86113
selections. Text in the preview can be selected and copied to the
87114
clipboard if required.
88115
</p>
89116
<p>
90-
Use the <em>Save</em> button to write the source code to disk or <em>
91-
Cancel</em> to abort.
117+
Use the <em>Save</em> button to write the unit to disk or <em>Cancel</em>
118+
to abort.
119+
</p>
120+
<h3>
121+
Footnote
122+
</h3>
123+
<p>
124+
&dagger; BOM = Byte Order Mark or Preamble: a sequence of bytes at the
125+
start of a text file that identifies its encoding.
92126
</p>
93127
</body>
94128
</html>

0 commit comments

Comments
 (0)