source: WorldVistAEHR/trunk/r/TEXT_INTEGRATION_UTILITIES-GMRP-TIU/TIUFLLM3.m@ 767

Last change on this file since 767 was 613, checked in by George Lilly, 15 years ago

initial load of WorldVistAEHR

File size: 6.2 KB
Line 
1TIUFLLM3 ; SLC/MAM - Library; LM Related: Docmentation on Templs H,A,I,T,D,P, Arrays TIUF1/2/3/B, Variables TIUFTMPL,TIUFSTMP,TIUFWHO,TIUFACT, Variable CONTENT in BUFENTRY^TIUFLLM3 ;10/25/95 21:21
2 ;;1.0;TEXT INTEGRATION UTILITIES;;Jun 20, 1997
3 ;
4 ; ***GENERAL DOCUMENTATION***
5 ; Note on Templates/Subtemplates:
6 ; As the words are used in the Document Definition Utility (TIUF):
7 ;TIUF Templates/Subtemplates are distinguished by what sort of entity
8 ;they display, e.g. they may display Document Definitions in Hierarchy,
9 ;or Items, or complete information on one Document Definition.
10 ; Variables TIUFTMPL/TIUFSTMP name the TIUF Sub/Template by letter
11 ;according to the entity displayed, e.g. T for Items, D for Detailed
12 ;Display, X for Boilerplate Text, H for Hierarchy (Edit DDEFS), A for
13 ;Attribute (Sort DDEFS), C for Create.
14 ; Template Actions CALL Subtemplates.
15 ; LIST MANAGER TEMPLATES have a many to one relation to TIUF
16 ;SUB/TEMPLATES: LM Templates are distinguished from each other by
17 ;1) what sort of entity they display, 2) what users they are intended
18 ;for, 3) what actions may be taken/ how some actions behave, and 4) the
19 ;type of the entry in the case of detailed display.
20 ; Variables TIUFTMPL/TIUFSTMP describe the sort of entity displayed.
21 ;TIUFWHO describes the intended user. TIUFACT* describes actions, which
22 ;may depend on the entry selected from a previous screen as well as on
23 ;the user. The LM Template called therefore may depend on all 3
24 ;variables: TIUFTMPL/TIUFSTMP, TIUFWHO, and TIUFACT* as well as on the
25 ;type of entry displayed.
26 ;
27 ; TIUF Templates are: H, A, C, J
28 ; TIUF Subtemplates are: D (called by H/A/C/J), X (called by H/A/C), and T (called by H/A,D).
29 ;
30 ; TIUF Template H corresponds to LM Templates:
31 ; TIUFH EDIT DDEFS CLIN,
32 ; TIUFH EDIT DDEFS MGR,
33 ; TIUF Template A corresponds to LM Templates:
34 ; TIUFA SORT DDEFS CLIN,
35 ; TIUFA SORT DDEFS MGR,
36 ; TIUF Template C corresponds to LM Templates:
37 ; TIUFC CREATE DDEFS MGR,
38 ; TIUF Subtemplate D corresponds to LM Templates:
39 ; TIUFD DISPLAY CLIN,
40 ; TIUFD DISPLAY MGR,
41 ; TIUFD DISPLAY VIEW (for objects AND nonobjects),
42 ; TIUFDJ DISPLAY OBJECT MGR (for objects).
43 ; TIUF Subtemplate X corresponds to LM Templates:
44 ; TIUFX BOILERPLATE TEXT
45 ; TIUFX BOILERPLATE TEXT VIEW
46 ; TIUF Subtemplate T corresponds to LM Templates:
47 ; TIUFT ITEMS ADD/EDIT/VIEW MGR
48 ; TIUFT ITEMS EDIT/VIEW CLIN
49 ; TIUFT ITEMS VIEW NATL/MGR/CLIN
50 ;
51 ; Note on Variables:
52 ; Variables TIUFTMPL, TIUFSTMP, TIUFWHO, TIUFACT*
53 ; TIUFTMPL = :
54 ; H for Template Edit Document Definitions,
55 ; A for Template Sort Document Definitions,
56 ; C for Template Create Document Definitions
57 ; J for Template Create Objects
58 ; TIUFTMPL names the option originally chosen by the user.
59 ; If TIUFSTMP does not exist, then the user is currently in
60 ; TIUFTMPL. If TIUFSTMP exists (along with TIUFTMPL), then
61 ; the user is currently in TIUFSTMP (and came from TIUFTMPL).
62 ; TIUFTMPL is set in Options TIUFH EDIT DDEFS, TIUFA SORT DDEFS, or TIUFC CREATE DDEFS, TIUFJ CREATE OBJECTS.
63 ; TIUFSTMP = :
64 ; T for Subtemplate Items,
65 ; D for Subtemplate Detailed Display,
66 ; X for Subtemplate Boilerplate Text
67 ; TIUFSTMP is set in rtns.
68 ; TIUFWHO = :
69 ; C for Clinician, M for Manager, N for National Developer.
70 ; TIUFWHO is set in Options TIUF/H/A/C/J EDIT/SORT/CREATE DDEFS
71 ; /OBJECTS.
72 ; TIUFACT*= :
73 ; For Subtemplate T:
74 ; TIUFACTT = A for TIUFT ITEMS ADD/EDIT/VIEW MGR
75 ; E for TIUFT ITEMS EDIT/VIEW CLIN
76 ; V for TIUFT ITEMS VIEW MGR/CLIN
77 ; For Subtemplate D:
78 ; TIUFACT = C for TIUFD DISPLAY CLIN
79 ; M,N for TIUFD DISPLAY MGR
80 ; V for TIUFD DISPLAY VIEW
81 ; For Subtemplate X:
82 ; TIUFACT = C,M,N for TIUFX BOILERPLATE TEXT
83 ; TIUFACT = V for TIUFX BOILERPLATE TEXT VIEW
84 ;
85 ; TIUFACT* is set in rtns
86 ;
87 ; In the TIUF Utility, LM Templates and Protocol Menus are named using
88 ;TIUFTMPL or TIUFSTMP, and lengthened or abbreviated forms of TIUFWHO
89 ;or TIUFACT.
90 ; EXAMPLE: Protocol TIUFA ACTION MENU CLIN is the Protocol Menu for
91 ;LM Template TIUFA SORT DDEFS CLIN, where A = TIUFTMPL = Sort DDEFs,
92 ;CLIN = lengthened TIUFWHO.
93 ;
94 ; Note on Major TMP Arrays:
95 ; TIUF uses 3 sets of TMP arrays: ^TMP("TIUF1" and associated arrays,
96 ;^TMP("TIUF2" and associated arrays, and ^TMP("TIUF3" and associated
97 ;arrays. It also uses a buffer array before setting data into the 3
98 ;above arrays: ^TMP("TIUFB". TMP arrays 1, 2, and 3 above are used for
99 ;LM Templates.
100 ; ^TMP("TIUF1" is the LM array for TIUF Templates H, A, C and J.
101 ; ^TMP("TIUF3" is the LM array for TIUF Subtemplates D and X.
102 ; ^TMP("TIUF2" is the LM array for TIUF Subtemplate T.
103 ; Modules for ^TMP("TIUF1"/2 optionally handle hierarchy display,
104 ;which updates the display for one entry when another entry is edited.
105 ; TIUF also uses ^TMP("TIUF",$J), which contains setup variables.
106 ;
107 ; Note on variable CONTENT in BUFENTRY^TIUFLLM2:
108 ;CONTENT is a string containing any of the following flags:
109 ; 80 info is limited to 80 chars. 80 can be FOLLOWED by another
110 ;flag, but it must be first. Commas are not necessary. Used to display
111 ;parents of Shared Components, to display parent in Template A Edit/
112 ;View. Other flags are mutually exclusive, i.e., string can contain
113 ;only one except for 80.
114 ; H info is for Hierarchy LM Template: need +, need levels, omit Items Column in Screen Display.
115 ; C info is for CREATE LM Template: need levels, omit Items Column in Screen Display.
116 ; A info is for Attribute Template: need Items, omit levels.
117 ; J info is for Object Template: omit levels, omit columns Type, In Use, Boiltext, Items
118 ; D info is item fields from item subfile; Shortened Name for Template D, no Number
119 ; O info is Name, Status, Owner, (IFN) of Title/Orphan Component with embedded Object; for Template D for Objects
120 ; T info is item fields from item subfile; Whole Name for Template T.
121 ; W Buffer array is not for insertion into LM array but only for
122 ;writing to screen. +INFO=0, and Buffer array starts with line 0; No number.
Note: See TracBrowser for help on using the repository browser.