home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR16 / DTSDDS.ZIP / DTSDDS.TPL < prev   
Text File  |  1993-07-25  |  12KB  |  285 lines
  1. #! *************************************************************************
  2. #!  DTSDDS.TPL   This template has been generated as a temporary solution
  3. #!               for creating a DICTIONARY listing from the DCT file.
  4. #!               This is no manner intended to supersede the formal Clarion
  5. #!               Software solution for printing the DCT listing.
  6. #!
  7. #!               Diversified Technology Solutions nor its principals nor
  8. #!               employees vow to the validity and operation of this
  9. #!               program.
  10. #!
  11. #!               Distributed as FREEWARE you are responsible to taking
  12. #!               necessary precautions to protect your investment,
  13. #!               particularly CLA and/or DCT files.
  14. #!
  15. #!               This product does not provide any means of error checking
  16. #!               to preclude overwriting any previously developed CLAs of
  17. #!               similar naming convention.
  18. #!
  19. #!               Since this is NOT a formal product offering, it does NOT
  20. #!               include formal documentation.  We STRONGLY suggest you
  21. #!               read the DTSDDS.DOC ASCII file included with this template
  22. #!               prior to using this template.
  23. #!
  24. #!               Should you have any questions, we may be reached via
  25. #!               CompuServe-Clarion Software forum or E-Mail at
  26. #!               76200,2531.
  27. #!
  28. #! *************************************************************************
  29. #PROGRAM
  30. #PROMPT('Program &Author',@S30),%Author
  31.  
  32. #! *************************************************************************
  33. #PROCEDURE(DDSList,'Create a listing of the Data Dictionary')
  34. #!╔════════════════════════════════════════════════════════════════════════
  35. #!║  DATA DICTIONARY DOCUMENTATION TEMPLATE                     DDSDDS.TPL
  36. #!║────────────────────────────────────────────────────────────────────────
  37. #!║  Written by: Samuel W. Bellamy III
  38. #!║              Diversified Technology Solutions
  39. #!║              June 30, 1993
  40. #!║─────────────────┬───────────┬──────────────────────────────────────────
  41. #!║ Revision Dates: │  930630   │Original Issue
  42. #!║─────────────────┼───────────┼──────────────────────────────────────────
  43. #!║                 │  930712   │  Added summarizing DDS listing.
  44. #!║                 │           │  Added MEMO information
  45. #!║─────────────────┼───────────┼──────────────────────────────────────────
  46. #!║                 │           │
  47. #!║                 │           │
  48. #!╚════════════════════════════════════════════════════════════════════════
  49. !
  50. ! ╔════════════════════════════════════════════════════════════════════════
  51. ! ║ Data Dictionary Listing for:                 %DictionaryFile
  52. ! ║
  53. ! ║        Listing Name: %Program
  54. ! ║       Creation Date: %ProgramDateCreated %ProgramTimeCreated
  55. ! ║       Modified Date: %ProgramDateChanged %ProgramTimeChanged
  56. ! ║
  57. ! ╚════════════════════════════════════════════════════════════════════════
  58. #PROMPT('&Methodlogy',OPTION),%DDSReportMethod
  59. #PROMPT('Full',RADIO)
  60. #PROMPT('Brief',RADIO)
  61.  
  62.  #FIX(%FILE,%PRIMARY)
  63.  #IF(%DDSReportMethod='Full')
  64.  
  65.  ▄▄▄▄▄ DETAILED FILE DEFINITIONS ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  66.  #FOR(%FILE)
  67.  
  68.  ▄▄▄▄ %FILE ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  69.  █ %FileDescription
  70.  █  Prefix: %FilePre               Name:   %FileName
  71.  █  Owner:  %FileOwner           Create:   %FileCreate
  72.  █  Driver: %FileType %FileTypeParameter
  73.  █  Primary Key: %PrimaryKey
  74.  █
  75.  █ ╔══ FIELDS ═════════════════════════════════════════════════════════════
  76.       #FOR(%FIELD)
  77.        #IF(%FIELDTYPE <> 'Memo')
  78.  █ ║  ┌── Field: %FieldID is %FieldDescription
  79.  █ ║  │       Data Type:  %FieldType (%FieldDisplayPicture)
  80.               #IF(%FieldPlaces)
  81.  █ ║  │       Decimal Places: %FieldPlaces
  82.               #ELSE
  83.  █ ║  │       Decimal Places: No decimal places defined.
  84.               #ENDIF
  85.               #IF(%FieldDimension1)
  86.  
  87.  █ ║  │       Dimensions: One  -%FieldDimension1 Two -%FieldDimension2
  88.  █ ║  │                   Three-%FieldDimension3 Four-%FieldDimension4
  89.               #ELSE
  90.  █ ║  │       Dimensions: None
  91.               #ENDIF
  92.               #IF(%FieldHelp)
  93.  █ ║  │       Help ID:    %FieldHelp
  94.               #ELSE
  95.  █ ║  │       Help ID: No help specified.
  96.               #ENDIF
  97.               #IF(%FieldRangeLow:Low)
  98.  █ ║  │       Range:           %FieldRangeLow:Low   %FieldRangeHigh:High
  99.               #ELSE
  100.  █ ║  │       Range: No data range specified.
  101.               #ENDIF
  102.               #IF(%FieldInitial)
  103.  █ ║  │       Initial Value:   %FieldInitial
  104.               #ELSE
  105.  █ ║  │       Initial Value: No Initial Value specified.
  106.               #ENDIF
  107.               #IF(%FieldChoices)
  108.  █ ║  │       Choices:         %FieldChoices
  109.               #ELSE
  110.  █ ║  │       Choices: No Choice options specified.
  111.               #ENDIF
  112.               #IF(%FieldLookup)
  113.  █ ║  │       Validation File: %FieldLookup
  114.               #ELSE
  115.  █ ║  │       Validation File: No Validation File specified.
  116.               #ENDIF
  117.  █ ║  └── END OF %FieldID IN %File ────────────────────────────────────────
  118.        #ELSE
  119.  █ ║  ┌── Field: %FieldID is %FieldDescription
  120.  █ ║  │       Data Type:  %FieldType of %FieldMemoSize bytes in a %FieldMemoRows by %FieldMemoWidth
  121.  █ ║  │           Image:  %FieldMemoImage
  122.  █ ║  └── END OF %FieldID IN %File ────────────────────────────────────────
  123.       #ENDIF
  124.       #ENDFOR
  125.  █ ╚══ END OF FIELDS ══════════════════════════════════════════════════════
  126.  █
  127.  █  ╔═ KEYS ═══════════════════════════════════════════════════════════════
  128.    #FOR(%KEY)
  129.  █  ║ ┌ Key: %Key
  130.     #FOR(%KEYFIELD)
  131.  █  ║ │         %KeyField %KeyFieldSequence
  132.     #ENDFOR
  133.         #IF(%KeyName)
  134.  █  ║ │ Name:   %KeyName  %KeyIndex
  135.         #ELSE
  136.  █  ║ │ Name: %Key
  137.         #ENDIF
  138.         #IF(%KeyAuto)
  139.  █  ║ │ Auto Incrementing?: %KeyAuto
  140.         #ELSE
  141.  █  ║ │ Auto Incrementing?: No Auto Incrementing Key specified.
  142.         #ENDIF
  143.         #IF(%KeyDuplicate)
  144.  █  ║ │ Allow Duplicates?: %KeyDuplicate
  145.         #ELSE
  146.  █  ║ │ Allow Duplicates?: No duplicate keys permitted.
  147.         #ENDIF
  148.  █  ║ └─ END OF %KEY IN %FILE ─────────────────────────────────────────────
  149.    #ENDFOR
  150.  █  ╚═ END OF KEYS IN %FILE ═══════════════════════════════════════════════
  151.  █
  152.  █  ╔═ RELATIONSHIPS IN %FILE ═════════════════════════════════════════════
  153.     #FOR(%RELATION)
  154.  █  ║   ┌── %FILE related to %Relation in a %RelationType
  155.  █  ║   │     Key: %RelationKey
  156.              #FOR(%RelationKeyField)
  157.               #IF(%RelationKeyFieldLink)
  158.  █  ║   │          %RelationKeyField links by %RelationKeyFieldLink
  159.               #ENDIF
  160.              #ENDFOR
  161.       #IF(%RelationConstraintDelete)
  162.  █  ║   │     Contraints  Delete:    %RelationConstraintDelete
  163.       #ELSE
  164.  █  ║   │     Contraints  Delete:    No Action
  165.       #ENDIF
  166.       #IF(%RelationConstraintUpdate)
  167.  █  ║   │                 Update:    %RelationConstraintUpdate
  168.       #ELSE
  169.  █  ║   │     Contraints  Update:    No Action
  170.       #ENDIF
  171.  █  ║   └─── End of %File for %Relation ───────────────────────────────────
  172.     #ENDFOR
  173.  █  ╚═══ END OF RELATIONSHIPS IN %FILE ════════════════════════════════════
  174.  █
  175.  ▀▀▀▀▀ END OF %FILE DESCRIPTION ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  176.  #ENDFOR
  177.  #ELSE
  178.  
  179.  ▄▄▄▄▄ SUMMARIZED FILE DEFINITIONS ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  180.  #FOR(%FILE)
  181.  
  182.  ▄▄▄▄ %FILE        ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  183.  █ %FileDescription
  184.  █  Prefix: %FilePre               Name:   %FileName
  185.  █  Driver: %FileType %FileTypeParameter
  186.  █
  187.  █ ╔══ FIELD  ═══ TYPE ═════ PICTURE ══════════ DESCRIPTION ═══════════════
  188.       #FOR(%FIELD)
  189.       #IF(%FieldType <> 'MEMO')
  190.  █ ║ %FieldID  │ %FieldType (%FieldDisplayPicture)│%FieldDescription
  191.       #ELSE
  192.  █ ║ %FieldID  │%FieldType %FieldMemoSize bytes in  %FieldMemoRows by %FieldMemoWidth for %FieldDescription
  193.       #ENDIF
  194.       #ENDFOR
  195.  █ ╚══ END OF FIELDs in %File ═════════════════════════════════════════════
  196.  █
  197.  █ ╔═ KEYS ═══ FIELD ══════════ SEQUENCE ═════════════════════════════════
  198.   #FOR(%KEY)
  199.     #FOR(%KEYFIELD)
  200.  █ ║────────────────────────────────────────────────────────────────────────
  201.  █ ║  %Key │ %KeyField │ %KeyFieldSequence │ %KeyIndex
  202.     #ENDFOR
  203.   #ENDFOR
  204.  █ ╚═ END OF KEYs IN %FILE ════════════════════════════════════════════════
  205.  █
  206.  █ ╔═ RELATIONSHIPS IN %FILE ══════════════════════════════════════════════
  207.   #FOR(%RELATION)
  208.  █ ║   ┌── %FILE related to %Relation in a %RelationType
  209.  █ ║   │     Key: %RelationKey
  210.              #FOR(%RelationKeyField)
  211.                #IF(%RelationKeyFieldLink)
  212.  █ ║   │          %RelationKeyField links by %RelationKeyFieldLink
  213.                #ENDIF
  214.              #ENDFOR
  215.      #IF(%RelationConstraintDelete)
  216.  █ ║   │     Contraints  Delete:    %RelationConstraintDelete
  217.      #ELSE
  218.  █ ║   │     Contraints  Delete:    No Action
  219.      #ENDIF
  220.      #IF(%RelationConstraintUpdate)
  221.  █ ║   │                 Update:    %RelationConstraintUpdate
  222.      #ELSE
  223.  █ ║   │     Contraints  Update:    No Action
  224.      #ENDIF
  225.  █ ║   └─── End of %File for %Relation ────────────────────────────────────
  226.   #ENDFOR
  227.  █ ╚═══ END OF RELATIONSHIPS IN %FILE ═════════════════════════════════════
  228.  █
  229.  ▀▀▀▀▀ END OF %FILE DESCRIPTION ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  230.  #ENDFOR
  231.  #ENDIF
  232.  
  233. #!╔═════════════════════════════════════════════════════════════════╗
  234. #!║ These PROCEDUREs MUST be present for GENERATOR          930630  ║
  235. #!╚═════════════════════════════════════════════════════════════════╝
  236. #PROCEDURE(TODO,'Return immediately (for incomplete procedures)')
  237. #!------------------------------------------------------------------------------
  238. #!
  239. #!                            The ToDo Template
  240. #!
  241. #!        The Todo Template generates code for all procedures
  242. #!        which may be called, but which have not yet been designed.
  243. #!
  244. #!        This template is reqired and must not be removed.
  245. #!
  246. #!------------------------------------------------------------------------------
  247. %Procedure       PROCEDURE
  248.    CODE
  249.    GLO:Message2 = CENTER('Procedure Undefined',45)
  250.    ShowWarning
  251.    RETURN                                      #<!Return to caller
  252. #!
  253. #PROCEDURE(External,'Document external procedure call')
  254. #!------------------------------------------------------------------------------
  255. #!
  256. #!                         The External Template
  257. #!
  258. #!        This template allows the redefinition of a Todo procedure
  259. #!        for any external procedures which may be called.
  260. #!        This allows you to specify that this particular procedure
  261. #!        is not a Todo procedure and no Todo code will be generated.
  262. #!
  263. #!        There is no source code for this procedure.  See the template
  264. #!        help for more information.
  265. #!
  266. #!------------------------------------------------------------------------------
  267. #!
  268. #MODULE
  269. #!------------------------------------------------------------------------------
  270. #!
  271. #!                            The Module Template
  272. #!
  273. #!    The Module template generates the MEMBER statement, MAP structure, and
  274. #!    module global declarations for a source module of a Clarion program.
  275. #!    There is only one #MODULE segment in a template file chain.
  276. #!
  277. #!------------------------------------------------------------------------------
  278.                 MEMBER('%Program')
  279. OMIT('╝')
  280. ╔════════════════════════════════════════════════════════════════════════════╗
  281. ║   %Module - %ModuleDescription                                             ║
  282. ╚════════════════════════════════════════════════════════════════════════════╝
  283. %ModuleData
  284. #EMBED('Data Section')
  285.