Skip to content

Commit 4040a56

Browse files
delphidabblerdelphidabbler
committed
Add new help topics re user database deletion
One new topic for Delete User Database dialogue box. One new topic re related "common" task. Update help index, TOC and project file as required.
1 parent a2a0d2d commit 4040a56

File tree

6 files changed

+142
-1
lines changed

6 files changed

+142
-1
lines changed

‎Src/Help/CodeSnip.hhp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ HTML\dlg_addcategory.htm
2525
HTML\dlg_backup.htm
2626
HTML\dlg_configcompilers.htm
2727
HTML\dlg_deletecategory.htm
28+
HTML\dlg_deleteuserdb.htm
2829
HTML\dlg_dependencies.htm
2930
HTML\dlg_dependencies_edit.htm
3031
HTML\dlg_duplicatesnippet.htm
@@ -96,6 +97,7 @@ HTML\task_addsnippets.htm
9697
HTML\task_backup.htm
9798
HTML\task_copysnippet.htm
9899
HTML\task_customise.htm
100+
HTML\task_deleteuserdb.htm
99101
HTML\task_export.htm
100102
HTML\task_generateunit.htm
101103
HTML\task_printroutine.htm

‎Src/Help/HTML/dlg_deleteuserdb.htm

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2+
<!--
3+
* This Source Code Form is subject to the terms of the Mozilla Public License,
4+
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
5+
* obtain one at https://mozilla.org/MPL/2.0/
6+
*
7+
* Copyright (C) 2022, Peter Johnson (gravatar.com/delphidabbler).
8+
*
9+
* Help topic for Delete User Database dialogue box.
10+
-->
11+
<html>
12+
<head>
13+
<meta
14+
http-equiv="Content-Type"
15+
content="text-html; charset=Windows-1252">
16+
<title>
17+
Delete User Database Dialogue Box
18+
</title>
19+
<link
20+
rel="stylesheet"
21+
href="../css/codesnip.css"
22+
type="text/css">
23+
</head>
24+
<body>
25+
<object
26+
type="application/x-oleobject"
27+
classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
28+
<param
29+
name="ALink Name"
30+
value="DeleteUserDBDlg">
31+
</object>
32+
<h1>
33+
<a name="dlg_deleteuserdb"></a>Delete User Database Dialogue Box
34+
</h1>
35+
<p>
36+
This dialogue box is displayed when you choose the <em>Database | Delete
37+
User Database</em> menu option.
38+
</p>
39+
<p class="bordered">
40+
<strong class="warning">Proceed with caution.</strong> If you give
41+
permission here, <strong>all</strong> your user-defined snippets will be
42+
deleted without further confirmation. <span class="warning">This action
43+
can't be undone</span>.
44+
</p>
45+
<p>
46+
Click <em>Cancel</em> to back out of this dialogue box.
47+
</p>
48+
<p>
49+
If you decide you really want to do this you must enter the upper case
50+
text <code>DELETE</code> <code>MY</code> <code>SNIPPETS</code> in the edit
51+
box, then press <em>OK</em>. You will get an error message, and the
52+
snippets won't be deleted, if the text you entered is incorrect.
53+
</p>
54+
<p>
55+
Once you enter the required text and click <em>OK</em> all user-defined
56+
snippets will be deleted straight away and the main display will be
57+
re-loaded.
58+
</p>
59+
<p class="bordered">
60+
You are <strong>strongly advised</strong> to take a backup of your
61+
snippets before deleting them, in case you change you mind. To do this
62+
first cancel this dialogue box then use the <em>Database | Backup User
63+
Database</em> menu option.
64+
</p>
65+
<h2>
66+
Why would you do this?
67+
</h2>
68+
<p>
69+
It's very unlikely you will need to delete all your snippets, but there
70+
is one use case where this facility is useful. That is when you are moving
71+
snippets from the standard version of CodeSnip to a portable version, or
72+
vice versa.
73+
</p>
74+
<p>
75+
For further details, see <a
76+
class="weblink"
77+
target="_blank"
78+
href="https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md#faq-8"
79+
>this FAQ</a>.
80+
</p>
81+
</body>
82+
</html>

‎Src/Help/HTML/menu_database.htm

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
55
* obtain one at https://mozilla.org/MPL/2.0/
66
*
7-
* Copyright (C) 2008-2021, Peter Johnson (gravatar.com/delphidabbler).
7+
* Copyright (C) 2008-2022, Peter Johnson (gravatar.com/delphidabbler).
88
*
99
* Help topic describing Database menu.
1010
-->
@@ -96,6 +96,18 @@ <h1>
9696
such as a <em>DropBox</em> or <em>Google Drive</em> sub-directory.
9797
</td>
9898
</tr>
99+
<tr>
100+
<td class="img">
101+
&nbsp;
102+
</td>
103+
<td class="item">
104+
Delete User Database
105+
</td>
106+
<td>
107+
Displays the <a href="dlg_deleteuserdb.htm">Delete User Database</a> dialogue box that asks for permission to delete <strong>ALL</strong> the snippets created by the user. If permission is granted then all snippets user defined snippets will be deleted without any further warning.
108+
<br><span class="warning">Use with caution &ndash; this action can't be undone.</span>
109+
</td>
110+
</tr>
99111
</table>
100112
<p>
101113
&dagger; The <em>Move User Database</em> option is not available in the

‎Src/Help/HTML/task_deleteuserdb.htm

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
2+
<!--
3+
* This Source Code Form is subject to the terms of the Mozilla Public License,
4+
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
5+
* obtain one at https://mozilla.org/MPL/2.0/
6+
*
7+
* Copyright (C) 2022, Peter Johnson (gravatar.com/delphidabbler).
8+
*
9+
* Help topic describing how to delete the user database.
10+
-->
11+
<html>
12+
<head>
13+
<meta http-equiv="Content-Type" content="text-html; charset=Windows-1252">
14+
<title>
15+
Delete User Defined Database
16+
</title>
17+
<link rel="stylesheet" href="../css/codesnip.css" type="text/css">
18+
</head>
19+
<body>
20+
<h1>
21+
<a name="task_deleteuserdb"></a>Delete the User-Defined Snippets Database
22+
</h1>
23+
<p>
24+
In the unlikely event you need to delete all of the user defined snippets from CodeSnip you can use the <em>Database | Delete User Database</em> menu option, which will display the <a href="dlg_deleteuserdb.htm">Delete User Database</a> dialogue box.
25+
</p>
26+
<p>
27+
There are very few use cases where you will want to delete the whole database, but one such case is where you want to move your snippets from a portable version of CodeSnip to a standard version, or vice-versa. For more information about this, see <a
28+
class="weblink"
29+
target="_blank"
30+
href="https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md#faq-8"
31+
>this FAQ</a>.
32+
</p>
33+
</body>
34+
</html>

‎Src/Help/Index.hhk

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@
7575
<param name="Name" value="customise codesnip">
7676
<param name="Local" value="HTML\task_customise.htm">
7777
</OBJECT>
78+
<LI> <OBJECT type="text/sitemap">
79+
<param name="Name" value="delete the whole user database">
80+
<param name="Local" value="HTML\task_deleteuserdb.htm">
81+
</OBJECT>
7882
<LI> <OBJECT type="text/sitemap">
7983
<param name="Name" value="duplicate snippet">
8084
<param name="Local" value="HTML\dlg_duplicatesnippet.htm">
@@ -383,6 +387,9 @@
383387
<LI> <OBJECT type="text/sitemap">
384388
<param name="Name" value="view menu">
385389
<param name="Local" value="HTML\menu_view.htm">
390+
<LI> <OBJECT type="text/sitemap">
391+
<param name="Name" value="delete user database dialogue">
392+
<param name="Local" value="HTML\dlg_deleteuserdb.htm">
386393
</OBJECT>
387394
</UL>
388395
</BODY></HTML>

‎Src/Help/TOC.hhc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,10 @@
144144
<param name="Name" value="Backup and Restore the User Database">
145145
<param name="Local" value="HTML\task_backup.htm">
146146
</OBJECT>
147+
<LI> <OBJECT type="text/sitemap">
148+
<param name="Name" value="Delete the whole User Database">
149+
<param name="Local" value="HTML\task_deleteuserdb.htm">
150+
</OBJECT>
147151
</UL>
148152
<LI> <OBJECT type="text/sitemap">
149153
<param name="Name" value="About the Kinds of Snippets">

0 commit comments

Comments
 (0)