Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Routine: TIUFLLM3

TIUFLLM3.m

Go to the documentation of this file. 
  1. 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
  1.  ;
  1.  ;                     ***GENERAL DOCUMENTATION***
  1.  ; Note on Templates/Subtemplates:
  1.  ;  As the words are used in the Document Definition Utility (TIUF):
  1.  ;TIUF Templates/Subtemplates are distinguished by what sort of entity
  1.  ;they display, e.g. they may display Document Definitions in Hierarchy,
  1.  ;or Items, or complete information on one Document Definition.
  1.  ; Variables TIUFTMPL/TIUFSTMP name the TIUF Sub/Template by letter
  1.  ;according to the entity displayed, e.g. T for Items, D for Detailed
  1.  ;Display, X for Boilerplate Text, H for Hierarchy (Edit DDEFS), A for
  1.  ;Attribute (Sort DDEFS), C for Create.
  1.  ; Template Actions CALL Subtemplates.  
  1.  ;  LIST MANAGER TEMPLATES have a many to one relation to TIUF
  1.  ;SUB/TEMPLATES:  LM Templates are distinguished from each other by
  1.  ;1) what sort of entity they display, 2) what users they are intended
  1.  ;for, 3) what actions may be taken/ how some actions behave, and 4) the 
  1.  ;type of the entry in the case of detailed display.
  1.  ;  Variables TIUFTMPL/TIUFSTMP describe the sort of entity displayed.
  1.  ;TIUFWHO describes the intended user.  TIUFACT* describes actions, which
  1.  ;may depend on the entry selected from a previous screen as well as on
  1.  ;the user.  The LM Template called therefore may depend on all 3
  1.  ;variables: TIUFTMPL/TIUFSTMP, TIUFWHO, and TIUFACT* as well as on the
  1.  ;type of entry displayed.
  1.  ;
  1.  ; TIUF Templates are:    H, A, C, J
  1.  ; TIUF Subtemplates are: D (called by H/A/C/J), X (called by H/A/C), and T (called by H/A,D).
  1.  ;
  1.  ; TIUF Template H corresponds to LM Templates:
  1.  ;   TIUFH EDIT DDEFS CLIN,
  1.  ;   TIUFH EDIT DDEFS MGR,
  1.  ; TIUF Template A corresponds to LM Templates:
  1.  ;   TIUFA SORT DDEFS CLIN,
  1.  ;   TIUFA SORT DDEFS MGR,
  1.  ; TIUF Template C corresponds to LM Templates:
  1.  ;   TIUFC CREATE DDEFS MGR,
  1.  ; TIUF Subtemplate D corresponds to LM Templates:
  1.  ;   TIUFD DISPLAY CLIN,
  1.  ;   TIUFD DISPLAY MGR,
  1.  ;   TIUFD DISPLAY VIEW (for objects AND nonobjects),
  1.  ;   TIUFDJ DISPLAY OBJECT MGR (for objects).
  1.  ; TIUF Subtemplate X corresponds to LM Templates:
  1.  ;   TIUFX BOILERPLATE TEXT
  1.  ;   TIUFX BOILERPLATE TEXT VIEW
  1.  ; TIUF Subtemplate T corresponds to LM Templates:
  1.  ;   TIUFT ITEMS ADD/EDIT/VIEW MGR
  1.  ;   TIUFT ITEMS EDIT/VIEW CLIN
  1.  ;   TIUFT ITEMS VIEW NATL/MGR/CLIN
  1.  ;
  1.  ; Note on Variables: 
  1.  ; Variables TIUFTMPL, TIUFSTMP, TIUFWHO, TIUFACT*
  1.  ;   TIUFTMPL = :
  1.  ;     H for Template Edit Document Definitions,
  1.  ;     A for Template Sort Document Definitions,
  1.  ;     C for Template Create Document Definitions
  1.  ;     J for Template Create Objects
  1.  ;       TIUFTMPL names the option originally chosen by the user.
  1.  ;       If TIUFSTMP does not exist, then the user is currently in
  1.  ;         TIUFTMPL.  If TIUFSTMP exists (along with TIUFTMPL), then
  1.  ;         the user is currently in TIUFSTMP (and came from TIUFTMPL).
  1.  ;       TIUFTMPL is set in Options TIUFH EDIT DDEFS, TIUFA SORT DDEFS, or TIUFC CREATE DDEFS, TIUFJ CREATE OBJECTS.
  1.  ;   TIUFSTMP = :
  1.  ;     T for Subtemplate Items,
  1.  ;     D for Subtemplate Detailed Display,
  1.  ;     X for Subtemplate Boilerplate Text
  1.  ;       TIUFSTMP is set in rtns.
  1.  ;   TIUFWHO = :
  1.  ;     C for Clinician, M for Manager, N for National Developer.
  1.  ;       TIUFWHO is set in Options TIUF/H/A/C/J EDIT/SORT/CREATE DDEFS
  1.  ;       /OBJECTS.
  1.  ;   TIUFACT*= :
  1.  ;     For Subtemplate T:
  1.  ;       TIUFACTT = A for TIUFT ITEMS ADD/EDIT/VIEW MGR
  1.  ;                  E for TIUFT ITEMS EDIT/VIEW CLIN
  1.  ;                  V for TIUFT ITEMS VIEW MGR/CLIN
  1.  ;     For Subtemplate D:
  1.  ;       TIUFACT = C for TIUFD DISPLAY CLIN
  1.  ;                 M,N for TIUFD DISPLAY MGR
  1.  ;                 V for TIUFD DISPLAY VIEW
  1.  ;     For Subtemplate X:
  1.  ;       TIUFACT = C,M,N for TIUFX BOILERPLATE TEXT
  1.  ;       TIUFACT = V for TIUFX BOILERPLATE TEXT VIEW
  1.  ;
  1.  ;         TIUFACT* is set in rtns
  1.  ;
  1.  ;  In the TIUF Utility, LM Templates and Protocol Menus are named using
  1.  ;TIUFTMPL or TIUFSTMP, and lengthened or abbreviated forms of TIUFWHO
  1.  ;or TIUFACT.
  1.  ;  EXAMPLE: Protocol TIUFA ACTION MENU CLIN is the Protocol Menu for 
  1.  ;LM Template TIUFA SORT DDEFS CLIN, where A = TIUFTMPL = Sort DDEFs,
  1.  ;CLIN = lengthened TIUFWHO.
  1.  ;
  1.  ; Note on Major TMP Arrays:
  1.  ;   TIUF uses 3 sets of TMP arrays: ^TMP("TIUF1" and associated arrays,
  1.  ;^TMP("TIUF2" and associated arrays, and ^TMP("TIUF3" and associated
  1.  ;arrays.  It also uses a buffer array before setting data into the 3
  1.  ;above arrays: ^TMP("TIUFB".  TMP arrays 1, 2, and 3 above are used for
  1.  ;LM Templates.
  1.  ;     ^TMP("TIUF1" is the LM array for TIUF Templates H, A, C and J.
  1.  ;     ^TMP("TIUF3" is the LM array for TIUF Subtemplates D and X.
  1.  ;     ^TMP("TIUF2" is the LM array for TIUF Subtemplate T.
  1.  ;  Modules for ^TMP("TIUF1"/2 optionally handle hierarchy display,
  1.  ;which updates the display for one entry when another entry is edited.
  1.  ; TIUF also uses ^TMP("TIUF",$J), which contains setup variables.
  1.  ;
  1.  ; Note on variable CONTENT in BUFENTRY^TIUFLLM2:
  1.  ;CONTENT is a string containing any of the following flags:
  1.  ;   80   info is limited to 80 chars. 80 can be FOLLOWED by another
  1.  ;flag, but it must be first.  Commas are not necessary.  Used to display
  1.  ;parents of Shared Components, to display parent in Template A Edit/
  1.  ;View.  Other flags are mutually exclusive, i.e., string can contain
  1.  ;only one except for 80.
  1.  ;   H    info is for Hierarchy LM Template: need +, need levels, omit Items Column in Screen Display.
  1.  ;   C    info is for CREATE LM Template: need levels, omit Items Column in Screen Display.
  1.  ;   A    info is for Attribute Template: need Items, omit levels.
  1.  ;   J    info is for Object Template: omit levels, omit columns Type, In Use, Boiltext, Items
  1.  ;   D    info is item fields from item subfile; Shortened Name for Template D, no Number
  1.  ;   O    info is Name, Status, Owner, (IFN) of Title/Orphan Component with embedded Object; for Template D for Objects
  1.  ;   T    info is item fields from item subfile; Whole Name for Template T.
  1.  ;   W    Buffer array is not for insertion into LM array but only for
  1.  ;writing to screen. +INFO=0, and Buffer array starts with line 0; No number.