DeScribe 5 - Tips and Techniques

DeScribe Safety Features

While there is no way to protect your data from corruption 100% of the time, DeScribe has tried to create as many barriers as possible from user error, corruption, and catastrophic operating system failures (power outages, hardware problems, etc.), and to aid you in recovery from problems that should occur. DeScribe's safety features include Unlimited Undo, Snapshots, automatic Backups, and a series of error reporting files that are created in the TEMP directory.

Unlimited Undo

DeScribe retains every "transaction" you make in your document in a buffer that can be accessed by using DeScribe's unique Undo feature. While many applications allow you to undo a step or two, (just like DeScribe's Flashback feature,) DeScribe's Unlimited Undo goes much further. Whenever you open a document and begin to enter text, add style changes, remove text, add tables, picture frames and graphics, all changes are recorded in your document in a buffer. This transaction record is maintained until you close and save the document. As long as the document is open and unsaved, you can choose Undo to "go back" to any earlier point in your document. This feature is especially useful for anyone who is editing a document and makes a mistake or other series of unwanted design decisions.

To use Undo

  1. Select Edit-Undo....
    A dialog box will appear with a scroll bar that says "Undo" and "Redo". Additionally, a Custom Tool is available to access Undo with a red and blue arrow.
  2. To undo desired changes
    Click on left arrow by Undo one mouse click at a time
    or
    Drag the bead from right to left.
  3. Click on the arrow by Redo or drag the bead if you have removed too many changes.
  4. Click OK.

Should you wish to physically save your document, but maintain the Undo buffer with all your data in it, you can used DeScribe's Copy to... feature to make a copy of your working document under another file name. Because the working document is unsaved the Undo buffer remains in tact. To access Copy To... select File-Copy To....

The Temp Directory

The DeScribe Temp directory is used to store many of the error detection and recovery files which are created in DeScribe. DeScribe creates this directory for you upon installation, but you can change the directory location in Options-Preferences-Directory.

Snapshots

DeScribe saves your document in the background at regular intervals as a protection from system failures. We refer to these as Snapshots, and a separate file will be created for each document you have open. Files created are saved in the TEMP directory with an extension of .SNP.

Anytime you close the document and exit DeScribe normally .SNP files are deleted to save on hard disk space. If a system failure does occur which does not allow for DeScribe and the file to close properly, the Snapshot file is retained on your hard drive.

The next time you start DeScribe you will receive a message (or messages if more than one Snapshot was created for multiple documents) that "DeScribe has detected a snapshot of xxxxxxxx". Restore?" When you click Yes, DeScribe will restore the document from the snapshot, and though you may have lost some recent changes, you should be able to get back to work. Note: If you were working on an Untitled document, the message may refer to "Untitled #1".

If you choose not to restore the Snapshot, DeScribe will delete the file. There is no way to recover a deleted Snapshot file.

The intervals that DeScribe uses to create Snapshots are defined in the Global Preferences dialog. The default settings are based on the number of keystrokes (300-500 characters) and number of seconds (180-300 or 3-5 minutes). Although the Snapshots work on a separate thread, and should cause no system slowdowns, some users who are extremely fast typists (in excess of 100 wpm) and who are working on equipment with 'less' memory, find that their "keyboard can't seem to keep up" with them. These users find it convenient to increase the Snapshot settings so they don't happen so frequently (5-8 minutes and 800-900 characters or even higher). Other users with chronic system problems find it more convenient to lower these settings to offer more frequent protection.

To change the Snapshot settings:

  1. Choose Options-Preferences-Global.
  2. Make changes to the Min. characters, Max. Characters, Min. seconds, Max. seconds as desired.
  3. Click OK.

Since the creation of a Snapshot is a "timed" event, it is physically possible for you not to have a document open long enough to have one created. For example, if a document is only open for two minutes and you type less than 100 characters, then no Snapshot will be created.

Occasionally, a system problem or DeScribe problem will corrupt the actual Snapshot file. When this occurs, DeScribe will attempt to recover the document, and you will receive a secondary DeScribe error message that will probably terminate DeScribe.It will say that the document is "corrupted", and give a DeScribe line number error message. If this unlikely situation occurs, there is usually no way to recover the actual document. You should cancel the recovery.

As an absolute last resort, desperate users can sometimes recover some of the text from the file.This may be useful where a document is quite long or there have been many recent changes, and absolutely no other recovery is possible.

First, you must change the name of the Snapshot file in the Temp directory before you start DeScribe, so that DeScribe does not try to recover the .SNP file. (Change the name to something besides "xxxx.SNP" making certain to remove the extension). Start DeScribe, which should no longer be offering to recover the Snapshot. Select File-Import and import the document as an ASCII file. This may allow you to recover blocks of text, but note that parts of the document may contain strange ASCII characters that represent either the corruption or frames and graphic information that can't be translated by the filter. You will need to search carefully for blocks of desired text.

Backups

The Backup up feature automatically creates a copy of your document whenever you save it multiple times. If you create a document and save it once, no backup file will be created, but if you make changes to the document and save it a second time, the document as it appeared before the changes were made will be saved in the Temp directory. As the document is changed, a new Backup will replace the old on the desktop.

This feature protects you from losing data due to a corruption in the working document which may be caused by a hard or floppy drive write error, or from a system problem, or even from DeScribe. Should you find that a working document is corrupted, simply open the backup in the Temp directory. Though your document will not be completely up to date, you will have whatever your last stopping point was.

Though this is an extremely useful feature, (critical to those who have had the misfortune to lose data before), many users do not have the free hard disk space to allow for these files to be continually created. For this reason, all of the Backup files appear in the Temp directory. This allows users to easily save the contents of this directory (via standard OS/2 Copy or Backup commands) on a regular basis and delete the files once safely stored elsewhere.

If you are very short on disk space, you may elect to disable this feature entirely. To disable automatic backups

  1. Select Options-Preferences-Global.
  2. Remove the check from Create backups.
  3. Click OK.

Error reporting files

The Temp directory also contains files that are created as markers whenever there is a problem in DeScribe. If there is a system failure, or an Internal error in DeScribe users may see files such as MEM0001, MEM0002, MEM0003, MEM0004, etc. Each time DeScribe ends abnormally, an error file may be recorded that begins with the characters "MEM". Usually these files are zero bytes long and only contain the date and time the error occurred.

In addition to the MEM files, users may see files that begin with W4W and PRN. The W4W files indicate a failure that occurred in a text import filter, and the PRN files indicate an error in background printing (which is available only in OS/2).

Most of the time these files can simply be deleted from the system occasionally. They contain no detailed information other than a date and time. Please note however that these files are sometimes used by LAN administrators and other 'larger' users to trace problems. For example, if a LAN user complains of system lockup in the afternoon, it may be possible to review the error files and discover that the lockup keeps occurring at a specific time. If there are other 'automatic' processes occurring at the same time, it may give the LAN administrator a bit more information to review to locate the source of the system problem.

On extremely rare occasions, the error file is created and is not zero bytes long. This may be the results of the nature of the problem that caused the error. Sometimes, if the error was indeed caused by DeScribe, a file that is more than zero bytes long will be useful to our development staff in tracing the error. However, in order for this information to be useful, we must learn of all details of the problem at the time it occurred. If you locate a MEM file that is longer than zero bytes long after the original error occurred, we won't be able to research the problem.

As with Snapshots, desperate users have sometimes located usable blocks of text in MEM files when no other quality backup of a document is available. Trying to recover these should be used as a last resort.

All material contained in these pages is the exclusive property of DeScribe Inc.
All rights reserved.