Skip to content

Commit 70ef078

Browse files
delphidabblerdelphidabbler
committed
Merge branch 'feature/163-update-save-snippet-info-help' into develop
Fixes #163
2 parents 4b77024 + 7d81f66 commit 70ef078

File tree

2 files changed

+101
-15
lines changed

2 files changed

+101
-15
lines changed

‎Docs/Design/FileFormats/saved.html

+22-8
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,27 @@ <h2>
6262
</ol>
6363

6464
<p>
65-
In the first case the snippet is always saved in rich text format.
65+
In the first case the snippet information can be saved as one of the following file types:
6666
</p>
6767

68+
<ul>
69+
<li>
70+
Plain text.
71+
</li>
72+
<li>
73+
HTML 5 files.
74+
</li>
75+
<li>
76+
XHTML files.
77+
</li>
78+
<li>
79+
Rich text files.
80+
</li>
81+
<li>
82+
Markdown files.
83+
</li>
84+
</ul>
85+
6886
<p>
6987
In the second two cases the following file types can be chosen by the user:
7088
</p>
@@ -88,7 +106,7 @@ <h2>
88106
</ul>
89107

90108
<p>
91-
There is no specific file format for these files, except that HTML 5, XHTML and RTF
109+
There is no specific file format for these files, except that HTML 5, XHTML, RTF and Markdown
92110
files conform to published specifications.
93111
</p>
94112

@@ -97,11 +115,7 @@ <h2>
97115
</h2>
98116

99117
<p>
100-
In the first case the RTF is always saved in ASCII format.
101-
</p>
102-
103-
<p>
104-
In the 2nd and 3rd cases the encodings used depend on the file type and user choice. Different file
118+
The available encodings used depend on the file type and user choice. Different file
105119
types have different encoding choices, as follows:
106120
</p>
107121

@@ -164,7 +178,7 @@ <h2>
164178
<dd>
165179
<ul class="squashed">
166180
<li>
167-
ANSI (system default code page). ASCII format is actually used.
181+
ASCII [for Snippet Information] or ANSI [otherwise]. Regardless of naming, ASCII format is always used.
168182
</li>
169183
</ul>
170184
</dd>

‎Src/Help/HTML/dlg_saveinfo.htm

+79-7
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,93 @@ <h1>
2828
</h1>
2929
<p>
3030
This dialogue box is displayed when the <em>File | Save Snippet
31-
Information</em> menu option is clicked. It is used to specify the
32-
name of the file into which information about the currently selected
33-
snippet is to be saved.
31+
Information</em> menu option is clicked. It is used to specify the file
32+
name, file type and encoding information for the snippet information
33+
that is to be saved.
3434
</p>
3535
<p>
36-
The saved snippet information is written in rich text format.
36+
The dialogue is a standard Windows save dialogue box with a few added
37+
options.
3738
</p>
3839
<p>
39-
This dialogue is a standard Windows save dialogue box. You specify the
40-
name and folder for the file in the usual way.
40+
You specify the name and folder for the file where the snippet information
41+
is to be written in in the usual way.
4142
</p>
4243
<p>
43-
Use the <em>Save</em> button to write the file to disk or press
44+
Use the <em>Save as type</em> drop down list to specify the type of file
45+
to be saved. Options are:
46+
</p>
47+
<ul>
48+
<li>Plain text.</li>
49+
<li>HTML</li>
50+
<li>XHTML</li>
51+
<li>Rich text format</li>
52+
<li>Markdown</li>
53+
</ul>
54+
<p>
55+
The HTML 5 and XHTML options are very similar and differ only in the
56+
type of HTML that is written. For either type an embedded CSS style
57+
sheet is used to style the document.
58+
</p>
59+
<p>
60+
When any of the HTML 5, XHTML or rich text file types are selected source
61+
code embedded in the snippet information will be syntax highlighted if
62+
the <em>Use syntax highlighting</em> check box is checked.
63+
</p>
64+
<p>
65+
The output file encoding can be be specified in the <em>File Encoding</em>
66+
drop down list. Options vary depending on the file type. Some file types
67+
support only a single encoding. The encodings are:
68+
</p>
69+
<ul>
70+
<li>
71+
<em>ANSI (Default)</em> &ndash; the system default ANSI encoding.
72+
Available as an option for plain text and Markdown file formats.
73+
</li>
74+
<li>
75+
<em>UTF-8</em> &ndash; UTF-8 encoding, with BOM<sup>&dagger;</sup>.
76+
Available as an option for plain text and Markdown file formats and
77+
as the only encoding available for HTML 5 and XHTML file formats.
78+
</li>
79+
<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.
83+
</li>
84+
<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.
88+
</li>
89+
<li>
90+
<em>ASCII</em> &ndash; The only encoding available for the rich text file.
91+
</li>
92+
</ul>
93+
<p>
94+
The output can be previewed by clicking the <em>Preview</em> button. This
95+
displays the snippet information in a dialogue box, formatted according to your
96+
selections. Text in the preview can be selected and copied to the
97+
clipboard if required.
98+
</p>
99+
<p>
100+
Use the <em>Save</em> button to write the snippet information to disk or choose
44101
<em>Cancel</em> to abort.
45102
</p>
103+
<p>
104+
<strong class="warning">Warning:</strong> When plain text or Markdown formatted
105+
snippet information is written in ANSI format it is possibe that the information
106+
contains characters that can't be represented in the system default ANSI encoding.
107+
If this happens a warning
108+
dialogue box is displayed whenever the snippet information is written to file
109+
or is previewed.
110+
</p>
111+
<h3>
112+
Footnote
113+
</h3>
114+
<p>
115+
&dagger; BOM = Byte Order Mark or Preamble: a sequence of bytes at the
116+
start of a text file that identifies its encoding.
117+
</p>
46118
</body>
47119

48120
</html>

0 commit comments

Comments
 (0)