home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / bdbull.zip / bdbull.doc < prev    next >
Text File  |  1998-09-12  |  4KB  |  103 lines
  1.  
  2.                                  ----------
  3.                                    BDBull
  4.                                  ----------
  5.                                    v 1.00
  6.                                  ----------
  7.  
  8.                     Bulletin Generator for Maximus BBS's.
  9.  
  10. What It Does:
  11. ~~~~~~~~~~~~~
  12.    Creates MECCA and (optionally) HTML files containing any news items that
  13. you want your users to see.
  14.  
  15. Legal Stuff:
  16. ~~~~~~~~~~~~
  17.    This program shouldn't do much more than take up room on your hard drive,
  18. but if it does, it wasn't my fault, honest :>
  19.  
  20. Installation:
  21. ~~~~~~~~~~~~~
  22.    Just unzip everything into it's own directory, and edit the config file to
  23. suit your needs. It should be pretty self-explanatory.
  24.  
  25. Usage:
  26. ~~~~~~
  27.    Edit the BDBULL.TXT file with all the bulletins you want. (There is no
  28. theoretical limit to the number of bulletins you can have, only as many as
  29. MECCA(p) will allow :> ). Keep in mind that there is a limit of 255
  30. charachters per line in effect.
  31.  
  32. The format of BDBULL.TXT is as follows;
  33.  
  34. date
  35. topic
  36. bulletin text
  37. /***/
  38.  
  39. The date can be one of two formats: MM/DD/YYYY or DD/MM/YYYY (see the config
  40. file for more info). Note that you *MUST* use a 4 digit year! If you don't,
  41. your bulletins will look ugly, and you will be laughed at by all your peers!
  42. Neener neener! (None of that Y2K nonsense for ME!).
  43.  
  44. The topic can be whatever you want, with a maximum of length of 50
  45. charachters.
  46.  
  47. The bulletin text can be about as long as you want, you can write one line
  48. bulletins or stories, it doesn't matter.
  49.  
  50. The next line is the important one, it's a seperator. As long as you have that
  51. line after every bulletin in the file (including the last one!) you shouldn't
  52. experience any problems. Remember that if you have that line anywhere within
  53. your bulletin text, things will all go haywire, and I'm pretty sure the
  54. results won't be pleasant! :>
  55.  
  56. When you've edited BDBULL.TXT to suit your needs, just run BDBULL(2).EXE to
  57. create the MECCA/HTML file. After that, you'll have to run MECCA(p) to compile
  58. the mecca to a BBS file for use on your BBS.
  59.  
  60. I've included sample BAT and CMD files that automates this whole ugly
  61. process. :>
  62.  
  63. Tokens:
  64. ~~~~~~~
  65.    You can use tokens in your BDBULL.TXT file in order to customize the
  66. output more to suit your needs. If you place the token "[%M]" at the
  67. beginning of a line, the rest of that line will be added only to the
  68. generated MECCA file. If you place the token "[%H]" at the beginning of
  69. a line, the rest of the line will be added only to the generated HTML
  70. file.
  71.  
  72. Trouble Shooting:
  73. ~~~~~~~~~~~~~~~~~
  74. Problem: I get a run-time error -206 when BDBULL2 runs, and nothing gets
  75.          created!
  76. Cause: This is usually caused by trying to create a file with a long file
  77.        name (LFN) on a FAT partition, or by attempting to create a file
  78.        with a filename longer then permitted.
  79. Solution: Either change the config file to only create non-LFN files, or
  80.           move BDBULL to an HPFS partition.
  81.  
  82. Problem: I get an "Invalid date format detected on line xxx"
  83. Cause: Just like it says. The date on the line number given isn't in the
  84.        format you specified in the config file.
  85. Solution: Re-edit BDBULL.TXT and change the date to the proper format.
  86.  
  87. Problem: My dates don't look right! Instead of July 1st, it says January 7th!
  88. Cause: Same as above. You've likely transversed the digits in the date.
  89. Solution: Edit BDBULL.TXT and change the date to the proper format.
  90.  
  91. Problem: The bulletins generated are UGLY!
  92. Cause: I'm not at all artistic, so sue me! *I* think the colors are very
  93.        nice, thank-you!
  94. Solution: Check the config file. You can change all of the colors yourself.
  95.           Or, if you're really creative, you could always edit the generated
  96.           MECCA (or HTML) file to suit your needs.
  97.  
  98. Contacting Me:
  99. ~~~~~~~~~~~~~~
  100.    If you want to contact me for whatever reason, I can be found on the web
  101. at http://tinys.oix.com/blackdeath, or via E-Mail at s_honsberger@usa.net.
  102. I've included my PGP public key if you wish to encrypt your message to me.
  103.