Skip to content

Commit 1eb2d60

Browse files
delphidabblerdelphidabbler
committed
Update help and file format docs for snippet files.
The help topics for the dialogue boxes displayed by the File menu options Save Annotated Source, Save Unit and Save Snippet Information were updated to reflect the changes made in issue 166. The documentation of saved file formats in Docs/Design/FileFormats/saved.html was similarly updated.
1 parent 011629b commit 1eb2d60

File tree

4 files changed

+56
-28
lines changed

4 files changed

+56
-28
lines changed

‎Docs/Design/FileFormats/saved.html‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ <h2>
5151

5252
<ol>
5353
<li>
54-
By saving snippet information to file from the <em>File | Save Snippet Information</em> menu option.
54+
By saving snippet information using the <em>File | Save Snippet Information</em> menu option.
5555
</li>
5656
<li>
57-
By saving snippets to file from the <em>File | Save Snippet</em> menu option.
57+
By saving snippets using the <em>File | Save Snippet</em> menu option.
5858
</li>
5959
<li>
60-
By saving units to file from the <em>File | Save Unit</em> menu option.
60+
By saving units using the <em>File | Save Unit</em> menu option.
6161
</li>
6262
</ol>
6363

@@ -115,7 +115,7 @@ <h2>
115115
</h2>
116116

117117
<p>
118-
The available encodings used depend on the file type and user choice. Different file
118+
The available encodings depend on the file type and user choice. Different file
119119
types have different encoding choices, as follows:
120120
</p>
121121

@@ -132,10 +132,10 @@ <h2>
132132
UTF-8
133133
</li>
134134
<li>
135-
Unicode little endian (UTF16-LE)
135+
UTF-16LE
136136
</li>
137137
<li>
138-
Unicode big endian (UTF16-BE)
138+
UTF-16BE
139139
</li>
140140
</ul>
141141
</dd>
@@ -178,7 +178,26 @@ <h2>
178178
<dd>
179179
<ul class="squashed">
180180
<li>
181-
ASCII [for Snippet Information] or ANSI [otherwise]. Regardless of naming, ASCII format is always used.
181+
ASCII
182+
</li>
183+
</ul>
184+
</dd>
185+
<dt>
186+
Markdown
187+
</dt>
188+
<dd>
189+
<ul class="squashed">
190+
<li>
191+
ANSI (system default code page)
192+
</li>
193+
<li>
194+
UTF-8
195+
</li>
196+
<li>
197+
UTF-16LE
198+
</li>
199+
<li>
200+
UTF-16BE
182201
</li>
183202
</ul>
184203
</dd>

‎Src/Help/HTML/dlg_saveinfo.htm‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ <h1>
6868
</p>
6969
<ul>
7070
<li>
71-
<em>ANSI (Default)</em> &ndash; the system default ANSI encoding.
71+
<em>ANSI Code Page <code>nnn</code></em> &ndash; ANSI encoding for the system default code page,
72+
where <code>nnn</code> is the code page for the user's locale.
7273
Available as an option for plain text and Markdown file formats.
7374
</li>
7475
<li>
@@ -77,14 +78,12 @@ <h1>
7778
as the only encoding available for HTML 5 and XHTML file formats.
7879
</li>
7980
<li>
80-
<em>Unicode (Little Endian)</em> &ndash; UTF-16 LE encoding, with
81-
BOM<sup>&dagger;</sup>. Available as an option for plain text files and Markdown
82-
file formats.
81+
<em>UTF-16 Little Endian</em> &ndash; UTF-16 LE encoding, with
82+
BOM<sup>&dagger;</sup>. Available as an option for plain text and Markdown file formats.
8383
</li>
8484
<li>
85-
<em>Unicode (Big Endian)</em> &ndash; UTF-16 BE encoding, with
86-
BOM<sup>&dagger;</sup>. Available as an option for plain text files and Markdown
87-
file formats.
85+
<em>UTF-18 Big Endian</em> &ndash; UTF-16 BE encoding, with
86+
BOM<sup>&dagger;</sup>. Available as an option for plain text and Markdown file formats.
8887
</li>
8988
<li>
9089
<em>ASCII</em> &ndash; The only encoding available for the rich text file.

‎Src/Help/HTML/dlg_savesnippet.htm‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -104,29 +104,34 @@ <h1>
104104
<p>
105105
The output file encoding can be be specified in the <em>File Encoding</em>
106106
drop down list. Options vary depending on the file type. Some file types
107-
support only a single encoding. The encodings are:
107+
support only a single encoding, in which case the drop down list will be
108+
disabled. The encodings are:
108109
</p>
109110
<ul>
110111
<li>
111-
<em>ANSI (Default)</em> &ndash; the system default ANSI encoding.
112-
Available for both plain text and Pascal include files and as the only
113-
option for rich text files.
112+
<em>ANSI Code Page <code>nnn</code></em> &ndash; ANSI encoding for the system default code page,
113+
where <code>nnn</code> is the code page for the user's locale.
114+
Available for both plain text and Pascal include files.
114115
</li>
115116
<li>
116117
<em>UTF-8</em> &ndash; UTF-8 encoding, with BOM<sup>&dagger;</sup>.
117118
Available for both plain text and Pascal include files and as the only
118-
option for XHTML files. If used for Pascal include files be warned that
119+
option for HTML5 and XHTML files. If used for Pascal include files be warned that
119120
the files will only compile with compilers that support Unicode source
120121
files.
121122
</li>
122123
<li>
123-
<em>Unicode (Little Endian)</em> &ndash; UTF-16 LE encoding, with
124+
<em>UTF-16 Little Endian</em> &ndash; UTF-16 LE encoding, with
124125
BOM<sup>&dagger;</sup>. Available for plain text files only.
125126
</li>
126127
<li>
127-
<em>Unicode (Big Endian)</em> &ndash; UTF-16 BE encoding, with
128+
<em>UTF-18 Big Endian</em> &ndash; UTF-16 BE encoding, with
128129
BOM<sup>&dagger;</sup>. Available for plain text files only.
129130
</li>
131+
<li>
132+
<em>ASCII</em> &ndash; ASCII encoding. Available as the only option for
133+
rich text files.
134+
</li>
130135
</ul>
131136
<p>
132137
The output can be previewed by clicking the <em>Preview</em> button. This

‎Src/Help/HTML/dlg_saveunit.htm‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,29 +89,34 @@ <h1>
8989
<p>
9090
The output file encoding can be be specified in the <em>File Encoding</em>
9191
drop down list. Options vary depending on the file type. Some file types
92-
support only a single encoding. The encodings are:
92+
support only a single encoding, in which case the drop down list will be
93+
disabled. The encodings are:
9394
</p>
9495
<ul>
9596
<li>
96-
<em>ANSI (Default)</em> &ndash; the system default ANSI encoding.
97-
Available for both plain text and Pascal unit files and as the only
98-
option for rich text files.
97+
<em>ANSI Code Page <code>nnn</code></em> &ndash; ANSI encoding for the system default code page,
98+
where <code>nnn</code> is the code page for the user's locale.
99+
Available for both plain text and Pascal unit files.
99100
</li>
100101
<li>
101102
<em>UTF-8</em> &ndash; UTF-8 encoding, with BOM<sup>&dagger;</sup>.
102103
Available for both plain text and Pascal unit files and as the only
103-
option for XHTML files. If used for Pascal units be warned that the
104+
option for HTML 5 and XHTML files. If used for Pascal units be warned that the
104105
unit will only compile with compilers that support Unicode source
105106
files.
106107
</li>
107108
<li>
108-
<em>Unicode (Little Endian)</em> &ndash; UTF-16 LE encoding, with
109+
<em>UTF-16 Little Endian</em> &ndash; UTF-16 LE encoding, with
109110
BOM<sup>&dagger;</sup>. Available for plain text files only.
110111
</li>
111112
<li>
112-
<em>Unicode (Big Endian)</em> &ndash; UTF-16 BE encoding, with
113+
<em>UTF-18 Big Endian</em> &ndash; UTF-16 BE encoding, with
113114
BOM<sup>&dagger;</sup>. Available for plain text files only.
114115
</li>
116+
<li>
117+
<em>ASCII</em> &ndash; ASCII encoding. Available as the only option for
118+
rich text files.
119+
</li>
115120
</ul>
116121
<p>
117122
The output can be previewed by clicking the <em>Preview</em> button. This

0 commit comments

Comments
 (0)