Skip to content

Commit b1626b0

Browse files
author
delphidabbler
committed
Add new backup and restore task help topic and reference it
Task referenced from help project, help index, help TOC, task list help topic and intro page of Install or Update DelphiDabbler Snippets Database wizard.
1 parent aadf459 commit b1626b0

File tree

6 files changed

+97
-3
lines changed

6 files changed

+97
-3
lines changed

‎Src/Help/CodeSnip.hhp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ HTML\snippet_routine.htm
9494
HTML\snippet_type.htm
9595
HTML\snippet_unit.htm
9696
HTML\task_addsnippets.htm
97+
HTML\task_backup.htm
9798
HTML\task_copysnippet.htm
9899
HTML\task_customise.htm
99100
HTML\task_export.htm

‎Src/Help/HTML/task_backup.htm‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
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 http://mozilla.org/MPL/2.0/
6+
*
7+
* Copyright (C) 2020, Peter Johnson (gravatar.com/delphidabbler).
8+
*
9+
* Help topic describing how to backup and restore the user database
10+
-->
11+
<html>
12+
<head>
13+
<meta
14+
http-equiv="Content-Type"
15+
content="text-html; charset=Windows-1252">
16+
<title>
17+
Backup and Restore User Database
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="TaskBackupRestore">
31+
</object>
32+
<h1>
33+
Backup and Restore the User Database
34+
</h1>
35+
<p>
36+
To protect against unexpected errors like hard disk failure it is wise to
37+
periodically backup your user database. <em>CodeSnip</em> has a tool to
38+
help with this: it can write your complete user database to a single file
39+
that you can archive safely. <em>CodeSnip</em> can recreate the user
40+
database from such backup files if necessary.
41+
</p>
42+
<p class="bordered">
43+
Note that backups <strong>do not</strong> include the main DelphiDabbler
44+
Snippets Database. This is because you can just download a fresh copy of
45+
it from the internet if you need to replace it. Use the <em>Database |
46+
Install or Update DelphiDabbler Snippets Database</em> menu option to do
47+
that.
48+
</p>
49+
<h2>
50+
How to create a backup
51+
</h2>
52+
<p>
53+
To perform the backup just select the <em>Database | Backup User
54+
Database</em> menu option. This displays a
55+
<a href="dlg_backup.htm">file dialogue box</a> where you specify a file to
56+
use for the backup. It is up to you how to name the file. Including the
57+
date of the backup may be a good idea.
58+
</p>
59+
<p>
60+
You can save the file to a USB drive or portable hard drive or put it
61+
something like a Dropbox or Google Drive folder.
62+
</p>
63+
<h2>
64+
How to restore a backup
65+
</h2>
66+
<p>
67+
Should the worst happen and you loose your user defined database you can
68+
recreate it from your latest backup.
69+
</p>
70+
<p>
71+
To do this use the <em>Database | Restore Backup</em> menu option. This
72+
displays a <a href="dlg_restore.htm">file dialogue box</a> where you can
73+
navigate to your chosen backup file. Select the file and click <em>OK</em>
74+
to restore the backup.
75+
</p>
76+
<p>
77+
If the backup file is valid it will replace any existing user database and
78+
then the whole database will be reloaded. All existing tabs in the user
79+
interface will be closed. When the database has finished reloading a
80+
new tab will open with a message informing that the database has been
81+
updated.
82+
</p>
83+
</body>
84+
</html>

‎Src/Help/HTML/tasks.htm‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ <h1>
6161
<li>
6262
<a href="task_export.htm">Export and Import Snippets</a>
6363
</li>
64+
<li>
65+
<a href="task_backup.htm">Backup and Restore the User Database</a>
66+
</li>
6467
</ul>
6568
</body>
6669
</html>

‎Src/Help/Index.hhk‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@
6363
<param name="Name" value="add snippets to the database">
6464
<param name="Local" value="HTML\task_addsnippets.htm">
6565
</OBJECT>
66+
<LI> <OBJECT type="text/sitemap">
67+
<param name="Name" value="backup and restore the user database">
68+
<param name="Local" value="HTML\task_backup.htm">
69+
</OBJECT>
6670
<LI> <OBJECT type="text/sitemap">
6771
<param name="Name" value="copy code snippets">
6872
<param name="Local" value="HTML\task_copysnippet.htm">

‎Src/Help/TOC.hhc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,10 @@
140140
<param name="Name" value="Export and Import Snippets">
141141
<param name="Local" value="HTML\task_export.htm">
142142
</OBJECT>
143+
<LI> <OBJECT type="text/sitemap">
144+
<param name="Name" value="Backup and Restore the User Database">
145+
<param name="Local" value="HTML\task_backup.htm">
146+
</OBJECT>
143147
</UL>
144148
<LI> <OBJECT type="text/sitemap">
145149
<param name="Name" value="About the Kinds of Snippets">

‎Src/Res/HTML/dlg-dbupdate-intro-tplt.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@
2424
<body>
2525

2626
<p class="framed">
27-
<span class="warning">Warning:</span> you are <strong>strongly advised</strong> to back up your user database before going ahead with this installation. To do this cancel this dialogue box then use the <em>Database | Backup User Database</em> menu option to create a backup. When you have done that please come back here.
28-
<!-- TODO: add a task help topic to describe how to perform and restore backups and link to it from here -->
29-
<!-- TODO: add an external action to backup database from here -->
27+
<span class="warning">Warning:</span> you are <strong>strongly advised</strong> to <a class="help-link" href="help:TaskBackupRestore">back up your user database</a> before going ahead with this installation. To do this cancel this dialogue box then use the <em>Database | Backup User Database</em> menu option to create a backup. When you have done that please come back here.
3028
</p>
3129

3230
<p>

0 commit comments

Comments
 (0)