home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / MISC / MOC / TECHREF.TXT < prev    next >
Encoding:
Text File  |  1993-12-31  |  4.4 KB  |  104 lines
  1. MoC         Master of Ceremonies            Technical Reference Manual
  2. ----------------------------------------------------------------------
  3. FORMAT OF MoC FILES
  4.  
  5. This is the native format used by MoC. The default extension is "MOC"
  6. though this can be changed (see "Configuration" below).
  7.  
  8. The file is an OPL database file and can be opened from an OPL
  9. program using a command of the form:
  10.  
  11.      OPEN filename$,log,h%,m%,t1$,t2$
  12.  
  13. The records are in random order and must be ordered by sorting on the
  14. numerical value of the h% field (the values of which are NOT
  15. contiguous).
  16.  
  17. The fields are defined as follows:
  18.  
  19. h% - Hash value that determines the order of the records. Negative
  20.      values are reserved and should be ignored. Positive values will
  21.      be unique and a record with a greater hash value comes after one
  22.      with a lesser value.
  23.  
  24. m% - Number of minutes duration of item. Zero indicates a heading.
  25.  
  26. t1$- First and second lines of text. Zero to 60 characters for t1$,
  27. t2$  180 characters for t2$. In the S3 version, niether line should
  28.      exceed 40 characters. All characters are allowed, except TAB.
  29.      In the S3a version, a semicolon will cause the line to split in
  30.      two in the smaller fonts.
  31.  
  32. There will never be more than 98 records with positive hash values in
  33. any one file.
  34.  
  35. ----------------------------------------------------------------------
  36. FORMAT OF WRD FILES
  37.  
  38. WRD files produced by MoC are suitable for processing in the Word
  39. application and printing out. They are, in fact, plain text files
  40. using TAB characters for layout. 
  41.  
  42. ----------------------------------------------------------------------
  43. FORMAT OF TAB FILES
  44.  
  45. TAB files are the preferred format for exchanging items between MoC
  46. files and are also useful for exchanging data with spreadsheets and
  47. other programs.
  48.  
  49. Each item is a record (line) in the file and there are three fields
  50. in each record separated by TAB characters.
  51.  
  52. The first field is the minutes represented as 1-4 numeric characters.
  53. A heading has a zero character in this field.
  54.  
  55. The second and third fields are the two lines of text. They must be
  56. less than 60 characters long for the second field, and 180 for the
  57. third. The second field must have at least one character.
  58.  
  59. The third field may be missing altogether and there may be additional
  60. fields after the third. Additional fields are ignored on input.
  61.  
  62. ----------------------------------------------------------------------
  63. FORMAT OF CSV FILES
  64.  
  65. CSV stands for "Comma separated variable" and is a common format for
  66. interchange between databases, spreadsheets and word processors. It is
  67. similar to the TAB format, except that the fields are separated by
  68. commas rather than TABs. So that the text fields may contain commas,
  69. they are also enclosed in quote marks. Any spaces in the file are
  70. ignored, unless they are between the quote marks in the text fields.
  71.  
  72. ----------------------------------------------------------------------
  73. CONFIGURATION
  74.  
  75. The application is structured as three code librarys (OPO files) and
  76. a small, top level application file (MOC.OPA). The source code for
  77. the OPA file is included to enable you to change the directory
  78. locations and data file extension in case of conflict with other
  79. applications. In order to make changes, download moc.opl (Series 3)
  80. or moca.opl (Series 3a) and the appropriate icon file (moc.pic, or
  81. moca.pic).
  82. If you re-configured the previous version in this way, note that it
  83. is no longer necessary to supply the directory and file extension to
  84. the runMoc: procedure. This information is now picked up from the
  85. APP block for compatibility with the S3a "Create new list" feature.
  86. One of the code libraries is my generic Series 3 application
  87. framework which handles all the details of asynchronous device
  88. handling including the keyboard and timers. This is available in a
  89. fully documented version with source code for use in your own
  90. applications.
  91.  
  92. ----------------------------------------------------------------------
  93. HISTORY
  94.  
  95. This is the second release version of MoC. The changes are mainly
  96. to take advantage of the new features in the Series 3a machine,
  97. however there are also minor improvements and bug-fixes for Series
  98. 3 users.
  99. Many thanks to those who made comments and reported the few small
  100. bugs that slipped through in the previous version.
  101.  
  102. ----------------------------------------------------------------------
  103.  
  104.