Skip to content

Commit faed3ae

Browse files
delphidabblerdelphidabbler
committed
Add help topics for swagview v0.x
1 parent 6227f4e commit faed3ae

File tree

3 files changed

+209
-0
lines changed

3 files changed

+209
-0
lines changed

‎help/swagview/0.0/getting-started.html

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
layout: help
3+
topic: Getting Started
4+
title: Getting Started | v0.x | SWAGView application help
5+
meta-title: "Help topic for the DelphiDabbler SWAGView application"
6+
---
7+
8+
<p>
9+
When you run <em>SWAGView</em> for the first time the display will be empty because the SWAG database has not been installed.
10+
</p>
11+
12+
<p>
13+
To install SWAG do the following:
14+
</p>
15+
16+
<ol class="wide">
17+
<li>
18+
Go to the <a href="https://github.com/delphidabbler/swag/releases">SWAG releases page</a> on Github.
19+
</li>
20+
<li>
21+
Choose the latest v1.0.x release (<em>SWAGView</em> doesn't know how to read any version including or after v1.1.x).
22+
</li>
23+
<li>
24+
Download the zip file named <code>dd-swag-&lt;version&gt;.zip</code> where &lt;version&gt; is the release version number. Make a note of the folder where you downloaded the file.
25+
</li>
26+
<li>
27+
In <em>SWAGView</em>, click the <em>Install SWAG Database...</em> button.
28+
</li>
29+
<li>
30+
In the resulting dialogue box enter the full path and file name of the zip file you downloaded in the edit box. You can click the <em>...</em> (ellipsis) button to the right of the edit box and choose the file from a standard file open dialogue box.
31+
</li>
32+
<li>
33+
Click the <em>Install</em> button. This button will only be enabled if the file you entered exists.
34+
</li>
35+
<li>
36+
Wait for the database to be installed. A window will be displayed during this process. Expect it to take a few seconds to extract the data from the zip file and to copy it to the correct location &ndash; there are hundreds of small files to copy.
37+
</li>
38+
</ol>
39+
40+
<p>
41+
If everything goes OK the SWAG categories will be displayed in the left hand pane of the main window. See the <a href="./overview">Overview</a> topic for information above how to use the program.
42+
</p>
43+
44+
<p>
45+
The next time you start <em>SWAGView</em> it will find the database, so you don't need to do this process again.
46+
</p>
47+
48+
<h2>
49+
Problems?
50+
</h2>
51+
52+
<p>
53+
If anything goes wrong a message describing the problem will be displayed. This can happen for a few reasons:
54+
</p>
55+
56+
<ul>
57+
<li>
58+
There was a file system problem. You might need to re-download the zip file.
59+
</li>
60+
<li>
61+
The file you selected is corrupt or is not a zip file. Try again and choose the correct file.
62+
</li>
63+
<li>
64+
The zip file does not contain the SWAG database. Try again and choose the correct file.
65+
</li>
66+
<li>
67+
The version of the database in the zip file is not supported. Try downloading a suitable version and try again.
68+
</li>
69+
</ul>
70+
71+
<p>
72+
Regardless of the reason for failure, the main display will remain empty and you can use the <em>Install SWAG Database...</em> button to try again.
73+
</p>
74+
75+
<p class="strong text-center">
76+
<a href="./">Back to index page</a>
77+
</p>

‎help/swagview/0.0/index.html

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: help
3+
topic: SWAGView v0.x Help
4+
title: Landing page | v0.x | SWAGView application help
5+
meta-title: "Help topic for the DelphiDabbler SWAGView application"
6+
---
7+
8+
<p class="lead">
9+
<em>SWAGView</em> is a simple viewer application for the SWAG snippet collection.
10+
</p>
11+
12+
<p>
13+
This is a very simple application that is easy to use. The following topics should tell you all you need to know.
14+
</p>
15+
16+
<h2>
17+
Topics
18+
</h2>
19+
20+
<ul class="list-group">
21+
<li class="list-group-item">
22+
<a href="./getting-started">Getting Started</a> &mdash; First time running <em>SWAGView</em>? Start here.
23+
</li>
24+
<li class="list-group-item">
25+
<a href="./overview">Overview</a> &mdash; An overview of how to use <em>SWAGView</em>.
26+
</li>
27+
</ul>
28+
29+
<h2>
30+
Useful links
31+
</h2>
32+
33+
<ul class="list-group">
34+
<li class="list-group-item">
35+
<a href="/software/swagview"><em>SWAGView</em> home page</a>
36+
</li>
37+
<li class="list-group-item">
38+
<a href="https://github.com/ddabapps/swagview">Source code <i class="fa fa-github"></i></a>
39+
</li>
40+
<li class="list-group-item">
41+
<a href="https://github.com/ddabapps/swagview">Latest releases <i class="fa fa-github"></i></a>
42+
</li>
43+
</ul>

‎help/swagview/0.0/overview.html

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
layout: help
3+
topic: Overview
4+
title: Overview | v0.x | SWAGView application help
5+
meta-title: "Help topic for the DelphiDabbler SWAGView application"
6+
---
7+
8+
<div class="callout callout-info">
9+
<div><i class="fa fa-pull-left fa-pencil-square-o fa-2x icon"></i></div>
10+
<div class="indent-lg">
11+
<p>
12+
This page assumes that you have installed the SWAG database. If not then read the <a href="./getting-started">Getting Started</a> topic first.
13+
</p>
14+
</div>
15+
</div>
16+
17+
<h2>
18+
Main Window
19+
</h2>
20+
21+
<p>
22+
Everything in <em>SWAGView</em> is done from the main window. It is split into four parts:
23+
</p>
24+
25+
<ol>
26+
<li>
27+
<p>
28+
The left hand pane displays a tree view. The top level entries are "categories". Each category contains multiple snippets ("packets" in SWAG terminology), the titles of which are displayed as child nodes of their category.
29+
</p>
30+
<p>
31+
To view the packets that belong to a category double-click the category, or select it with the cursor keys and press ENTER or the right arrow key.
32+
</p>
33+
<p>
34+
Double click on a packet title, or select it and press ENTER, to display it.
35+
</p>
36+
<div class="callout callout-info">
37+
<div><i class="fa fa-pull-left fa-pencil-square-o fa-2x icon"></i></div>
38+
<div class="indent-lg">
39+
<p>
40+
When you open a category for the first time there will be a slight delay while the program loads the required packet titles from the database. A category's packets have been loaded if the <i class="fa fa-caret-right"></i> expand icon is displayed to the left of the category name in the tree view.
41+
</p>
42+
</div>
43+
</div>
44+
</li>
45+
<li>
46+
<p>
47+
The right hand pane shows the content of a packet that has been chosen in the tree view. The packet will either be Pascal source code or plain text.
48+
</p>
49+
<p>
50+
You can read the packet or select some or all of the text to copy to the clipboard.
51+
</p>
52+
</li>
53+
<li>
54+
<p>
55+
The pane at the top of the window contains the following buttons, from left to right:
56+
</p>
57+
<ul>
58+
<li>
59+
<p>
60+
<em>Update SWAG Database...</em> (or <em>Install SWAG Database...</em> if the SWAG database has not yet been installed).
61+
</p>
62+
<p>
63+
Use this button to install or update the database. Regardless of the button caption the same dialogue box is used, and the process is the same as that described in the <a href="./getting-started">Getting Started</a> topic.
64+
</p>
65+
</li>
66+
<li>
67+
<p>
68+
<em>Help</em>
69+
</p>
70+
<p>
71+
Displays this online help.
72+
</p>
73+
</li>
74+
</ul>
75+
<p>
76+
Information about the program and SWAG database versions is displayed at the right hand side to the pane.
77+
</p>
78+
<p>
79+
When the program is accessing the database a <em>Loading...</em> message will be displayed in the center of the pane.
80+
</p>
81+
</li>
82+
<li>
83+
The pane at the bottom of the window displays brief hints about navigating the tree view.
84+
</li>
85+
</ol>
86+
87+
<p class="strong text-center">
88+
<a href="./">Back to index page</a>
89+
</p>

0 commit comments

Comments
 (0)