home *** CD-ROM | disk | FTP | other *** search
/ Collection of Hack-Phreak Scene Programs / cleanhpvac.zip / cleanhpvac / DEVELOP.ZIP / DIR.DOC < prev    next >
Text File  |  1991-12-09  |  5KB  |  105 lines
  1. Some have asked for the file format for PCBoard's DIR files.  In the past this
  2. has never been documented thinking that it was almost intuitively obvious what
  3. the format is (DIR files being ascii format after all).  However, here's a
  4. technical breakdown of EXACTLY what it takes to make a properly formatted DIR
  5. file that PCBoard can recognize and process (example in between the two ******
  6. lines below):
  7.  
  8. *******************************************************************************
  9.  1) =====[  PCBoard v 14.5a Program Files  ]==================================
  10.  2)
  11.  3) %C:\PCB\DIR\DISCLAIM
  12.  4)
  13.  5) The PCBoard v14.5a software is available through a door called PCBOARD.
  14.  6) To download v14.5a software simply type "PCBOARD" at the command prompt.
  15.  7)
  16.  8) PCBDEMO1.ZIP   315899  11-22-91  PCBoard 14.5a Demo Disk #1
  17.  9) PCBDEMO2.ZIP   259140  11-22-91  PCBoard 14.5a Demo Disk #2
  18. 10) PCBDEMO3.ZIP   192391  11-22-91  PCBoard 14.5a Demo Disk #3
  19. 11) PCBDEMO4.ZIP   330754  11-22-91  PCBoard 14.5a Demo Disk #4
  20. 12)
  21. 13) PCBoard VROOM Overlay Size Adjustment
  22. 14) -------------------------------------
  23. 15) OVLSIZE.ZIP      7986  11-25-91  Use to adjust the size of the overlay buf
  24. 16)                                | in the VROOM OVERLAY version of PCBoard v
  25. 17)                                | or v14.5a.
  26. *******************************************************************************
  27.  
  28.  
  29. Headers, footers and any other regular text:
  30. --------------------------------------------
  31.    Lines 1-2, 4-7 and 12-13 are all considered regular text lines.  They can be
  32.    used for headers (text that is displayed before the file listing), footers
  33.    (text that can be displayed after the file listing) or if you DISABLE the
  34.    "sort" function for a particular DIR file they can be located anywhere in
  35.    the middle of the file.
  36.  
  37.    The only restriction is that they be 78 characters in length or less.
  38.  
  39.  
  40. Include files:
  41. --------------
  42.    Line 3 is an example of an include file.  The file C:\PCB\DIR\DISCLAIM
  43.    would be displayed to the caller after showing lines 1 and 2 and before
  44.    showing the rest of the file.
  45.  
  46.    Anything contained in the include file will be displayed with no limit on
  47.    file length or line width.  PCBoard does NOT display the existing line
  48.    (i.e. "%C:\PCB\DIR\DISCLAIM" is not displayed) to the caller.
  49.  
  50.  
  51. Primary file listings:
  52. ----------------------
  53.    Lines 8-11 and 15 are all considered primary file listing lines.  The
  54.    important aspects of each line are as follows:
  55.  
  56.    1) The file name is valid and contains no spaces within it.
  57.    2) The file size is flush right in column #21.  No commas please.
  58.    3) The file date begins in column #24 and uses dashes to separate the
  59.       MM-DD-YY format.  All values less than 10 include leading zeroes as
  60.       in "01" instead of " 1".
  61.    4) The file description begins in column 34 and must not extended beyond 78.
  62.  
  63.  
  64. Secondary file listings:
  65. ------------------------
  66.    Secondary lines allow you to improve the description of a file by providing
  67.    a much longer description.  Rules for valid secondary lines are as follows:
  68.  
  69.    1) Must follow a valid primary or secondary file listing.
  70.    2) Must begin with a space in the first column.
  71.    3) Must include a vertical bar (a | character) somewhere on the line (the
  72.       default is in column 32 just to the right of the end of the date field).
  73.  
  74.    PCBoard will, when displaying the file to the caller, remove the vertical
  75.    bar so as not to clutter up the display with extraneous characters.
  76.  
  77.  
  78. Colorization:
  79. -------------
  80. PCBoard performs automatic colorization of the DIR files as they are being
  81. displayed by recognizing headers, footers, file names, sizes, dates,
  82. descriptions and secondary lines according to the above rules and according to
  83. the color scheme defined via PCBFiler's "Choose DIR Colors" function.
  84.  
  85. Any additional colorations (via @-codes) desired are permissable as long as
  86. they are placed in non-column-sensitive areas such as:  headers, footers, file
  87. descriptions, secondary lines, etc.  You would not be able to place color codes
  88. anywhere to the left of the end of the date field in a file listing.
  89.  
  90. Older versions of PCBoard allowed graphics versions of DIR files such as
  91. creating both a DIR10 as well as a DIR10G file.  PCBoard v14.5 and beyond no
  92. longer support the "G" version of the file due to the automatic colorization
  93. being built directly into PCBoard.  This saves both disk space as well as
  94. probably some lost hair which probably occured when DIRxxG files became out of
  95. synch with their non-colorized counterparts.
  96.  
  97.  
  98. PCBFiler's Master List
  99. ----------------------
  100. PCBFiler automatically removes @-codes, includes any %FILESPEC include files,
  101. and removes vertical bars while it creates a master listing of your files.  In
  102. other words, the file created by PCBFiler is as readable (and without any
  103. control codes being displayed) as when PCBoard displays your files to an online
  104. caller who is in non-graphics mode.
  105.