home *** CD-ROM | disk | FTP | other *** search
/ ASP Monthly 1996 May / ASP_CD_9605.iso / bbsvend / toc.doc < prev   
Text File  |  1995-05-30  |  4KB  |  88 lines
  1.  
  2.  DOZ/TOC Data Structure                       Revised : 05-31-95 03:12am
  3.  -----------------------------------------------------------------------
  4.  
  5.  CONTENTS.TOC is designed to be the central database for the ASP CD-ROM.
  6.  It contains information about the various programs, including various
  7.  program filenames, detailed descriptions, author info, etc.
  8.  
  9.  It's designed primarily for use by the software on the CD, but may
  10.  be accessed by user-written utilities to provide extended services to
  11.  the recipients of the CD.  Through CONTENTS.TOC, alternate front-ends,
  12.  direct BBS software access, lookup utilities and more should be easily
  13.  possible.
  14.  
  15.  CONTEBTS.TOC will always be in the root directory of the CD, where
  16.  utility programs will be able to access it.
  17.  
  18.  The file is simply a string of DESCRIBE-type DOZ records appended into
  19.  a single file.  Since each record is 2,560 bytes in length, the number
  20.  of records can be determined by dividing the file length by 2560.
  21.  
  22.  The structure of each record is:
  23.  
  24.   element
  25.    length    data type     description                            value
  26.  ----------------------------------------------------------------------
  27.       2      string        DOZ file signature                       DS
  28.       2      integer       data version                              1
  29.      24      string        program name
  30.       8      string        program category
  31.       1      byte          category list version                     0
  32.       8      string        program version number
  33.       2      integer       author's program number
  34.      12      string        documentation filespec
  35.      12      string        registration filespec
  36.       8      string        ZIP file name (excluding ".ZIP")
  37.       8      string        install command
  38.       8      string        configuration command
  39.       8      string        program run command
  40.       8      string        author's default directory for installation
  41.       8      string        disk volume label to be used on vendor disks
  42.       4      long integer  disk space required for install
  43.       2      integer       non-zero if VGA required to run program
  44.       2      integer       non-zero if mouse required to run program
  45.   10x45      string        BBS description (from FILE_ID.DIZ)
  46.   20x75      string        long text description (wrapped)
  47.       6      string        record date (YYMMDD)
  48.       2      integer       program language (default to 0 for english)
  49.      30      string        author name
  50.       2      integer       ASP author number
  51.      30      string        author address line 1
  52.      30      string        author address line 2
  53.      30      string        author address line 3
  54.      30      string        author address line 4
  55.      20      string        RESERVED
  56.      20      string        RESERVED
  57.      40      string        author E-Mail address
  58.       3      string        author's prefered language file (for DESCRIBE)
  59.       8      string        ASP CD directory location
  60.       6      string        RESERVED
  61.       8      string        ZIP file date (MM-DD-YY)
  62.       4      long integer  ZIP file size
  63.      76      string        RESERVED
  64.       2      integer       RESERVED
  65.       2      integer       RESERVED
  66.       2      integer       RESERVED
  67.       2      integer       RESERVED
  68.       6      string        processing date (internal use only)
  69.       2      integer       delta flag (non-zero if new file)
  70.       1      string        operating system    'D' - MS DOS
  71.                                                'W' - Windows
  72.                                                'O' - OS/2
  73.                                                'M' - Macintosh
  74.     121      string        RESERVED for future use
  75.  ----------------------------------------------------------------------
  76.  
  77.  conventions:
  78.  
  79.  - strings are fixed length, blank padded and unterminated
  80.  - accessing software should confirm signature bytes before accessing
  81.  - current data version is 1, and will change only if the currently
  82.    defined elements of the structure change - addition of new elements
  83.    in RESERVED areas will not cause a change in the data version number
  84.  - category list version is 0 and will change only if the category list
  85.    is restructured in such a way that would make the recorded categories
  86.    meaningless
  87.  
  88.