STANDARD DATA DICTIONARY #9.2 -- HELP FRAME FILE 3/24/25 PAGE 1
STORED IN ^DIC(9.2, (766 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 8.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains the text of help frames created via the Help Processor (XQH). Help frames may be associated with options or
with data dictionary fields to provide on-line instruction. The file is cross-referenced by name, header, date entered, author,
and editor.
DD ACCESS: #
DEL ACCESS: #
AUDIT ACCESS: #
APPLICATION GROUP(S): XU
IDENTIFIED BY: HEADER (#1)
POINTED TO BY: RELATED FRAME field (#1) of the RELATED FRAME sub-field (#9.22) of the HELP FRAME File (#9.2)
HELP FRAME field (#3.7) of the OPTION File (#19)
CROSS
REFERENCED BY: AUTHOR(AC), EDITOR(AD), RELATED FRAME(AE), NAME(B), HEADER(C), DATE ENTERED(D), INVOKED BY ROUTINE(D)
9.2,.001 NUMBER NUMBER
INPUT TRANSFORM: K:+X'=X!(X>1000000)!(X<1)!(X?.E1"."1N.N) X
HELP-PROMPT: TYPE A WHOLE NUMBER BETWEEN 1 AND 1000000
DESCRIPTION:
This field uniquely identifies a help frame.
9.2,.01 NAME 0;1 (Required)
SHORT DESCRIPTION OF THE FRAME
INPUT TRANSFORM: D CHKNAME^XQ5 K:$L(X)>30!(X?.N)!($L(X)<3)!'(X'?1P.E)!(X'?.ANP) X
LAST EDITED: FEB 02, 1994
HELP-PROMPT: NAME MUST BE 3-30 CHARACTERS, NOT NUMERIC OR STARTING WITH PUNCTUATION
DESCRIPTION:
The unique name of the frame, preceded with the package prefix name, similar to option names.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 9.2^B
1)= S ^DIC(9.2,"B",$E(X,1,30),DA)=""
2)= K ^DIC(9.2,"B",$E(X,1,30),DA)
CROSS-REFERENCE: ^^TRIGGER^9.2^4
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(0)=X S Y(1)=$S($D(^DIC(9.2,D0,0)):^(0),1:"") S X=$P(Y(1),U,3)
="" I X S X=DIV S Y(1)=$S($D(^DIC(9.2,D0,0)):^(0),1:"") S X=$P(Y(1),U,3),X=X S DIU=X K Y X ^DD(9.2,
.01,1,2,1.1) X ^DD(9.2,.01,1,2,1.4)
1.1)= S X=DIV N %I,%H,% D NOW^%DTC S X=%
1.4)= S DIH=$S($D(^DIC(9.2,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,3)=DIV,DIH=9.2,DIG=4 D ^DICR:$O(
^DD(DIH,DIG,1,0))>0
2)= Q
CREATE CONDITION)= DATE ENTERED=""
CREATE VALUE)= NOW
DELETE VALUE)= NO EFFECT
FIELD)= DATE ENTERED
This trigger sets the 'DATE ENTERED' field to the date and time when the help frame is created.
CROSS-REFERENCE: ^^TRIGGER^9.2^6
1)= X ^DD(9.2,.01,1,3,1.3) I X S X=DIV S Y(1)=$S($D(^DIC(9.2,D0,0)):^(0),1:"") S X=$P(Y(1),U,4),X=X
S DIU=X K Y X ^DD(9.2,.01,1,3,1.1) X ^DD(9.2,.01,1,3,1.4)
1.1)= S X=DIV X ^DD(9.2,.01,1,3,49.2) S %=$S($D(^VA(200,+DUZ,0)):^(0),1:""),X=$S('DUZ:"??",X="#":DU
Z,X="N":$P(%,U,1),X="I":$P(%,U,2),X="T":$S($D(^DIC(3.1,+$P(%,U,9),0)):$P(^(0),U,1),1:""),X="NN":$S(
$D(^VA(200,+DUZ,.1)):$P(^(.1),U,4),1:""),1:"??") K %
1.3)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(0)=X S Y(1)=$S($D(^DIC(9.2,D0,0)):^(0),1:"") S X=$S('$D(^VA
(200,+$P(Y(1),U,4),0)):"",1:$P(^(0),U,1))=""
1.4)= S DIH=$S($D(^DIC(9.2,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,4)=DIV,DIH=9.2,DIG=6 D ^DICR:$O(
^DD(DIH,DIG,1,0))>0
2)= Q
49.2)= S X="#"
CREATE CONDITION)= AUTHOR=""
CREATE VALUE)= USER("#")
DELETE VALUE)= NO EFFECT
FIELD)= author
This cross reference marks Help Frames with the creater in the Author field.
9.2,1 HEADER 0;2 FREE TEXT
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>65!($L(X)<2) X
HELP-PROMPT: ANSWER MUST BE 2-65 CHARACTERS IN LENGTH
DESCRIPTION:
A short description of the frame, succinctly describing the content of the frame
CROSS-REFERENCE: 9.2^C^KWIC
1)= F %=1:1 Q:$P(X," ",%,99)="" S I=$P(X," ",%) I $L(I)>2,$L(I)<31,^DD("KWIC")'[I S ^DIC(9.2,"C",I
,DA)=""
2)= F %=1:1 Q:$P(X," ",%,99)="" S I=$P(X," ",%) I $L(I)>2,$L(I)<31 K ^DIC(9.2,"C",I,DA)
9.2,2 TEXT 1;0 WORD-PROCESSING #9.21
DESCRIPTION: The actual text of the help frame, which will be displayed when the user presses question mark.
Screen breaks are indicated by a line terminating with "..".
THE ACTUAL TEXT OF THE FIELD, IN DIWE FORMAT
LAST EDITED: AUG 15, 1991
HELP-PROMPT: ANSWER MUST BE 1-72 CHARACTERS IN LENGTH
DESCRIPTION: The actual text of the help frame, which will be displayed when the user presses question mark.
Screen breaks are indicated by a line terminating with "..".
9.2,3 RELATED FRAME 2;0 Multiple #9.22 (Add New Entry without Asking)
DESCRIPTION: This is a multiple field which contains information on the other help frames which are related to
the current help frame through specific keywords. The keywords may be selected to obtain
additional information about the topic through the related help frame(s).
9.22,.01 RELATED FRAME KEYWORD 0;1 FREE TEXT (Multiply asked)
FRAMES WHICH MAY BE CHOSEN FOR GREATER DETAIL, AT THE USER'S DISCRETION
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1)!'(X?.PNU) X
LAST EDITED: AUG 01, 1991
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION: A keyword appears in the text surrounded by brackets. When the user enters the keyword, a
related frame will be displayed with more detailed information on the topic suggested by the
keyword.
EXECUTABLE HELP: Q ;S Y=22 D EN^XQH ;Unknow what this was to do.
CROSS-REFERENCE: 9.22^B
1)= S ^DIC(9.2,DA(1),2,"B",$E(X,1,30),DA)=""
2)= K ^DIC(9.2,DA(1),2,"B",$E(X,1,30),DA)
9.22,1 RELATED FRAME 0;2 POINTER TO HELP FRAME FILE (#9.2)
LAST EDITED: MAR 15, 1995
DESCRIPTION: The internal name of another help-frame which can be invoked by the keyword to obtain more
detailed information on a sub-topic.
CROSS-REFERENCE: 9.2^AE
1)= S ^DIC(9.2,"AE",$E(X,1,30),DA(1),DA)=""
2)= K ^DIC(9.2,"AE",$E(X,1,30),DA(1),DA)
3)= For clean-up tools
9.2,3.5 Want to LOAD KEYWORDS (Y/N)? 0;5 FREE TEXT
INPUT TRANSFORM: D LOADKW^XQH2
LAST EDITED: JUL 24, 1986
HELP-PROMPT: Enter 'Y' if you wish to make all bracketed words appearing in the text into keywords.
DESCRIPTION: This field is designed for internal use. Its input transform will invoke a routine to associate
keywords with related help frames.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
9.2,4 DATE ENTERED 0;3 DATE
INPUT TRANSFORM: S %DT="ET" D ^%DT S X=Y K:Y<1 X
DESCRIPTION: Date/time that this frame was entered into the system, which is used to track new Help frame
activity.
WRITE AUTHORITY: ^
NOTES: TRIGGERED by the NAME field of the HELP FRAME File
TRIGGERED by the NAME field of the HELP FRAME File
CROSS-REFERENCE: 9.2^D
1)= S ^DIC(9.2,"D",$E(X,1,30),DA)=""
2)= K ^DIC(9.2,"D",$E(X,1,30),DA)
9.2,5 INVOKED BY ROUTINE 3;0 Multiple #9.23 (Add New Entry without Asking)
DESCRIPTION: This field is for documentation purposes. It serves as a record of which routines reference a
particular help frame.
9.23,.01 INVOKED BY ROUTINE 0;1 FREE TEXT
NOT USED AT THE MOMENT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
LAST EDITED: JUN 10, 1985
HELP-PROMPT: ANSWER MUST BE 3-30 CHARACTERS IN LENGTH
DESCRIPTION: This field is for documentation purposes. It serves as a record of which routines reference a
particular help frame.
CROSS-REFERENCE: 9.2^D
1)= S ^XHLP("D",$E(X,1,30),DA(1),DA)=""
2)= K ^XHLP("D",$E(X,1,30),DA(1),DA)
9.2,6 AUTHOR 0;4 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: SEP 08, 1989
DESCRIPTION: The person who created the entry for this help frame. This is a triggered field, it's value
determined by the creator of the .01 entry.
WRITE AUTHORITY: ^
NOTES: TRIGGERED by the NAME field of the HELP FRAME File
TRIGGERED by the NAME field of the HELP FRAME File
CROSS-REFERENCE: 9.2^AC
1)= S ^DIC(9.2,"AC",$E(X,1,30),DA)=""
2)= K ^DIC(9.2,"AC",$E(X,1,30),DA)
9.2,7 EDITOR 4;0 POINTER Multiple #9.24
DESCRIPTION:
Users who are allowed to edit this help frame, as determined by the author.
9.24,.01 EDITOR 0;1 POINTER TO NEW PERSON FILE (#200) (Multiply asked)
A LIST OF FRAMES WHICH SHOULD BE SEQUENTIALLY SCANNED AFTER THIS ONE.
LAST EDITED: SEP 08, 1989
DESCRIPTION:
Users who are allowed to edit this help frame, as determined by the author.
EXECUTABLE HELP: Q
CROSS-REFERENCE: 9.24^AB
1)= S ^DIC(9.2,DA(1),4,"AB",$E(X,1,30),DA)=""
2)= K ^DIC(9.2,DA(1),4,"AB",$E(X,1,30),DA)
CROSS-REFERENCE: 9.2^AD
1)= S ^DIC(9.2,"AD",$E(X,1,30),DA(1),DA)=""
2)= K ^DIC(9.2,"AD",$E(X,1,30),DA(1),DA)
9.2,8 DATE LAST UPDATED ; COMPUTED DATE
MUMPS CODE: S Y(9.2,8,1)=$S($D(^DIC(9.2,D0,1,0)):^(0),1:"") S X=$P(Y(9.2,8,1),U,5)
ALGORITHM: S Y(9.2,8,1)=$S($D(^DIC(9.2,D0,1,0)):^(0),1:"") S X=$P(Y(9.2,8,1),U,5)
LAST EDITED: OCT 13, 1985
DESCRIPTION: This field is used to maintain an indication of the date on which the help frame was last modified
or updated.
9.2,10.1 ENTRY EXECUTE STATEMENT 10.1;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: JAN 16, 1991
HELP-PROMPT: This is Standard MUMPS code which will be executed as the user enters this Help Frame
DESCRIPTION: This field is used to include an M code statement which is executed as the user enters this help
frame.
WRITE AUTHORITY: "@"
9.2,10.2 EXIT EXECUTE STATEMENT 10.2;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: JAN 16, 1991
HELP-PROMPT: This is Standard MUMPS code which will be executed as the user leaves the current Help Frame.
DESCRIPTION: This field is used to provide an M code statement which is to be executed as the user exits the
current help frame (whether moving into another help frame or back out of the current help frame).
WRITE AUTHORITY: "@"
FILES POINTED TO FIELDS
HELP FRAME (#9.2) RELATED FRAME:RELATED FRAME (#1)
NEW PERSON (#200) AUTHOR (#6)
EDITOR:EDITOR (#.01)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
XQHNEW/REVISED FRAMES DEC 06, 1985 USER #0 NEW/REVISED HELP FRAMES
SORT TEMPLATE(S):
XQHNEW/REVISED FRAMES OCT 13, 1985 USER #0
SORT BY: ]'NAME// (User is asked range)
WITHIN NAME, SORT BY: DATE LAST UPDATED// (User is asked range)
XUZ DOC MAR 19, 1989@17:18 USER #0
SORT BY: @#NAME// (User is asked range)
FORM(S)/BLOCK(S):