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