|
|
|
|
|
The edExplain command edits the explanation text for one or more message tags.
Synopsis
edExplain {msgID} [...]
Description
The edExplain command edits the explanation text for one or more message tags.
Environment variables for the edExplain command are described in the following table:
Environment variable |
Description |
EDITOR |
The program used to edit the explanation text (default: vi) |
EXPLAINDIR |
The root directory of the explanation texts (default: /gendb/data/explain) |
VERBOSITY |
If set to anything, edExplain runs verbosely |
An explanation file is basically a clear text file. Its contents are displayed as-is to the user when this explanation is requested. If it is a primary explanation procedure (an explanation that the end-user wants to reference by name), it should begin with a line of the form:
<< {tag} [{tag}...] >>
This identifies the explanation or procedure and all its alternate names as defined in the translation file, $EXPLAINDIR/translateLst.
The translateLst file should be updated to include the msgID, msg string, and file name, in which the explain text can be found (usually just the msgID name). When exiting the translateLst file, enter :w! followed by q.
Two exceptions exist to the rule that the file contains clear text that is displayed to the user:
Example
In the following example, the first line is the SCCS identification line and is not displayed to the end user. The second line identifies the explanation. The third line describes the problem.
# %W% %T% %H%
<< TWIP007 TWIP_BDERR >>
.... text of explanation describing what a T1 card error means...
