home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_UTIL / FDL_V410.ZIP / STRUC201.FDL < prev    next >
Text File  |  1994-04-03  |  4KB  |  78 lines
  1. Structure  V 2.01
  2. -----------------
  3.  
  4. This document  will give  a description  of the  internal format  of the
  5. FileDoor/DISP-compatible tag-file.
  6.  
  7. 3th  party  programs   (non-DISP  programs)  can   use  this   structure
  8. description  to  create  compatible  tag-files  that  can be accessed by
  9. FileDoor 2.xx and  higher versions. FileDoor  will stay compatible  with
  10. this release of the  structure until (at least)  version 3.01 even if  a
  11. new structure is implemented:
  12.  
  13.  
  14. A FileDoor/DISP-compatible  tag-file <tm>  will contain  1 header record
  15. (layout  in  FDTHea_Lay)   and  up  to   255  data-records  (layout   in
  16. FDTDAT_lay)
  17.  
  18. The file is a Turbo-PASCAL typed  file but can also be created  with any
  19. other language. Remember that a Turbo Pascal STRING[xx] is equal to  the
  20. structure ARRAY  [0..xx] OF  CHAR, where  element 0  contains the binary
  21. length of used part of the string.
  22.  
  23. {*****************************************************************************
  24. * Usage  : FileDoor/DISP compatible TAG-file                                 *
  25. * Written: 05-01-1991                                                        *
  26. * Author : R.W. van Hoeven                                                   *
  27. * Updates: V  2.01 05-01-1991  Changes:                                      *
  28. *                              - New                                         *
  29. *****************************************************************************}
  30.    FDTHea_Lay=RECORD
  31.       FDT_ID                                            :STRING[8];
  32.       FDTAut                                            :BOOLEAN;
  33.       FDTNam                                            :STRING[40];
  34.       FDTPrg                                            :STRING[8];
  35.       FDTDes                                            :STRING[40];
  36.    END;
  37.  
  38.    FDTDat_Lay=RECORD
  39.       FDTFil                                            :STRING[12];
  40.       FDTCom                                            :STRING[87];
  41.    END;
  42.  
  43. Header.FDT_ID  must contain FDTAG201
  44.  
  45. Header.FDTAut  is  set  to  TRUE  if  the  file is an AUTOLOAD  tag-file
  46.            otherwise it is set to FALSE;
  47.  
  48. Header.FDTNam  must contain the user-name as passed by the BBS;
  49.  
  50. Header.FDTPrg  is the name of the door that changed the file last;
  51.  
  52. Header.FDTDes  is a description that  can be added by the door  that has
  53.            created the file. This comment  is showed to the user  in
  54.            FileDoor (download);
  55.  
  56. Data__.FDTFil  is the  name of  the file  (filename.ext format) that  is
  57.            added to the tag-file;
  58.  
  59. Data__.FDTCom  is not used yet. It will be used for the directory  where
  60.            the program is stored. Don't use this entry yet.
  61.  
  62.  
  63. At any  given time  there can  be only  ONE tag-file  for a  certain BBS
  64. line. The door must check if there is already a tag-file for that  users
  65. and if so must act  upon it (append to it  or ask the user if  it can be
  66. deleted or not and if not, terminate door).
  67.  
  68. The filename is  fixed to BBSTAGFL.lll  where lll is  the BBS-linenumber
  69. without leading zeros.  So BBSTAGFL.1 for  line 1, BBSTAGFL.21  for line
  70. 21 and so on.
  71.  
  72. If a  door appends  to a  tag-file, the  door must  change Header.FDTNam
  73. (and  optionally  Header.FDTDes).  If  Header.FDTAut  is set, it is good
  74. practice to leave it on.  If it is off, you  can set it to on.  FileDoor
  75. 3.01 will set it to X'FF' when the user used the tag-file and started  a
  76. download. So make  it good practice  to check for  X'FF' first (you  can
  77. then delete the tag-file) and if not X'FF' test for TRUE or FALSE.
  78.