Skip to content

Commit f6773c1

Browse files
committed
Updated relevant help topics re SWAG-related changes
1 parent 6f0eaf0 commit f6773c1

File tree

2 files changed

+60
-40
lines changed

2 files changed

+60
-40
lines changed

Src/Help/HTML/about_swag.htm

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,34 @@ <h1>
2828
</h1>
2929
<p>
3030
SWAG is a collection of source code and program examples for the Pascal
31-
programming language that was maintained up to the end of 1997.
31+
programming language that was maintained up to the end of 1997. Each chunk
32+
of source code or example is known as a <em>packet</em>.
3233
</p>
3334
<p>
34-
Although the SWAG database is old it is extensive and some of the code is
35+
Although the SWAG database is old, it is extensive and some of the code is
3536
still relevant for today's programs.
3637
</p>
3738
<p>
3839
<em>CodeSnip</em> provides the
3940
<a href="dlg_swagimport.htm">SWAG Import Wizard</a> that enables you to
40-
browse a local copy of the SWAG database and import any of its snippets
41-
into your snippets database.
41+
browse a local copy of the SWAG database and convert any of its packets
42+
into snippets that can be imported into your local snippets database
4243
</p>
4344
<p>
4445
You can download the database from the <a
4546
href="https://github.com/delphidabbler/swag"
4647
class="weblink"
4748
target="_blank"
48-
><code>delphidabbler/swag</code></a> project on GitHub. Go to the <em>releases</em> tab and download the latest version. Unpack the zip file into an empty folder then run the SWAG Import Wizard and navigate to the folder where you extracted the zip file contents.
49+
><code>delphidabbler/swag</code></a> project on GitHub. Go to the
50+
<em>releases</em> tab and download the latest supported version&dagger;.
51+
Unpack the zip file into an empty folder then run the SWAG Import Wizard
52+
and navigate to the <code>swag</code> sub-directory of the folder where
53+
you extracted the zip file . The wizard reads the database and guides you
54+
through the import process.
55+
</p>
56+
<p>
57+
&dagger; The first page of the SWAG Import Wizard specifies which versions
58+
of SWAG are supported by CodeSnip.
4959
</p>
5060
</body>
5161
</html>

Src/Help/HTML/dlg_swagimport.htm

Lines changed: 45 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,18 @@ <h1>
2727
SWAG Import Wizard
2828
</h1>
2929
<p>
30-
This wizard is used to enable you to import snippets from the
30+
This wizard is used to enable you to import <em>packets</em> from the
3131
<a href="about_swag.htm">SWAG Database</a> into your code snippets
32-
database. The wizard is accessed from the <em>Snippets | Import
32+
database. (A SWAG <em>packet</em> is roughly the equivalent of a
33+
<em>CodeSnip</em> snippet: packets are converted into snippets before
34+
being imported.)
35+
</p>
36+
<p>
37+
The wizard is accessed from the <em>Snippets | Import
3338
Snippets From SWAG</em> menu option.
3439
</p>
3540
<h2>
36-
Page 1: <em>Import snippets from SWAG</em>
41+
Page 1: <em>Import packets from SWAG as new snippets</em>
3742
</h2>
3843
<p>
3944
This page gives an overview of how to use the wizard.
@@ -51,11 +56,15 @@ <h2>
5156
Page 2: <em>Select SWAG database download folder</em>
5257
</h2>
5358
<p>
54-
On this page you need to provide the full path to the folder where you
55-
downloaded the SWAG database. Enter the path in the edit box. You can
56-
click the ellipsis button to the right of the edit box to display a
57-
standard browse for folder dialogue box and choose the folder from there.
58-
The chosen folder will be entered into the edit box for you.
59+
On this page you need to provide the full path to the SWAG database on
60+
your system. By default the required folder is the <code>swag</code>
61+
sub-directory of the folder where you extracted the SWAG zip file.
62+
</p>
63+
<p>
64+
Enter the path in the edit box. You can click the ellipsis button to the
65+
right of the edit box to display a standard browse for folder dialogue box
66+
and choose the folder from there. The chosen folder will be entered into
67+
the edit box for you.
5968
</p>
6069
<p>
6170
Once you have entered the path click <em>Next</em>. The data in the folder
@@ -65,53 +74,53 @@ <h2>
6574
displayed and the page will not change.
6675
</p>
6776
<h2>
68-
Page 3: <em>Select required snippets</em>
77+
Page 3: <em>Select required packets</em>
6978
</h2>
7079
<p>
7180
When this page is first displayed it displays all the categories of
72-
snippets available in the SWAG database in the <em>SWAG categories</em>
81+
packets available in the SWAG database in the <em>SWAG categories</em>
7382
list box.
7483
</p>
7584
<p>
76-
Choose a category in the list and click the <em>Show Snippets In
77-
Category</em> button to display a list of its snippets in the right
85+
Choose a category in the list and click the <em>Show Packets In
86+
Category</em> button to display a list of its packets in the right
7887
hand list box. Alternatively just double-click the category name. The
79-
first time you choose a category the wizard will read the list of snippets
88+
first time you choose a category the wizard will read the list of packets
8089
from the database and a progress bar may be displayed while this is done.
8190
</p>
8291
<p>
83-
Select any snippets you want to import by ticking the check box next to
84-
the snippet's name. If you want to preview the snippet before deciding
85-
whether to import it, highlight the snippet and click the <em>Preview
86-
Selected Snippet</em> button. Alternatively just double click the snippet
87-
name. The snippet will then be read from the database (if necessary) and
88-
displayed in a dialogue box.
92+
Select any packets you want to import by ticking the check box next to
93+
the packet's name. If you want to preview the packet before deciding
94+
whether to import it, highlight it and click the <em>Preview Selected
95+
Packet</em> button. Alternatively just double click the packet name. The
96+
packet will then be read from the database (if necessary) and displayed
97+
in a dialogue box.
8998
</p>
9099
<p>
91100
Repeat this process for further categories if you wish. When you are
92-
ready to import your chosen snippets click the <em>Next</em> button to
93-
display the next page. Note that you must select at least one snippet in
101+
ready to import your chosen packets click the <em>Next</em> button to
102+
display the next page. Note that you must select at least one packet in
94103
order to move on.
95104
</p>
96105
<p>
97-
<strong class="warning">Warning:</strong> Do not select too many snippets
106+
<strong class="warning">Warning:</strong> Do not select too many packets
98107
to be imported at one time because the import process is not very
99108
efficient and can take a long time.
100109
</p>
101110
<h2>
102111
Page 4: <em>Ready to import</em>
103112
</h2>
104113
<p>
105-
This page lists all the snippets you have selected for import along with
106-
the unique ID (i.e. snippet name) that will be assigned to it after
107-
import. Note that some snippets may need to be retrieved from the SWAG
108-
database when the page is displayed and a progress bar may be displayed
109-
while this happens.
114+
This page lists all the packets you have selected for import along with
115+
the unique ID (i.e. snippet name) that will be assigned to the
116+
<em>CodeSnip</em> snippet after import. Note that some packets may need to
117+
be retrieved from the SWAG database when the page is displayed and a
118+
progress bar may be displayed while this happens.
110119
</p>
111120
<p>
112121
You should review your selection. If you want to make any changes use the
113122
<em>Back</em> button to go back to the previous page and de-select any
114-
unwanted snippets or select any snippets you may have missed.
123+
unwanted packets or select any you may have missed.
115124
</p>
116125
<p>
117126
When you are ready to proceed, click the <em>Import</em> button. Once
@@ -124,9 +133,9 @@ <h2>
124133
Page 5: <em>Import complete</em>
125134
</h2>
126135
<p>
127-
This page simply confirms the import has completed. You should note that
128-
all the snippets will have been imported into the same special category,
129-
the name of which will be displayed.
136+
This page simply confirms the import has completed. All the selected
137+
packets will have been converted to snippets and imported into the same
138+
special category, the name of which will be displayed.
130139
</p>
131140
<p>
132141
Click the <em>Finish</em> button to close the wizard.
@@ -136,10 +145,11 @@ <h2>
136145
snippet.
137146
</p>
138147
<p>
139-
<strong>Note:</strong> <em>CodeSnip</em> does not track snippets imported
140-
from SWAG, so if you import the same snippet more than once it will be
141-
duplicated in your local database &ndash; it will not overwrite the
142-
original. You will not be warned about such duplications.
148+
<strong class="warning">Warning:</strong> <em>CodeSnip</em> does not track
149+
packets imported from SWAG, so if you import the same packet more than
150+
once a duplicate snippet will be created for it in your local database
151+
&ndash; the original will not be overwritten. You will not be warned about
152+
such duplications.
143153
</p>
144154
</body>
145155
</html>

0 commit comments

Comments
 (0)