home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / HM11A.ZIP / 11111111.111 / HMQUOTE.DOC < prev    next >
Text File  |  1992-08-16  |  4KB  |  106 lines
  1. Harmony Quoter
  2.  
  3. HMquote is a small quoting program provided as a companion to Harmony BBS.  
  4. Every time HMQuote is executed, an ASCII and ANSI text file will be created 
  5. with a random quote.  HMQuote is automatically installed with Harmony BBS.  
  6. Actually, it is installed in two ways with Harmony.  
  7.  
  8. First, HMquote is set up to run from the batch file LOGFILES.BAT.  Remember, 
  9. this batch file is run everytime a full logon is executed.  HMQuote MUST be 
  10. run in the directory that all of it's data files are found.  If they are not 
  11. there, HMQuote will abort.  Therefore, the first thing LOGFILES.BAT must do is 
  12. change to the directory that HMquote and the data files are found.  Harmony's 
  13. install puts these files in the SYSTEM directory.
  14.  
  15. Second,  the quote files that HMquote creates are set up as Logon Text Files, 
  16. as explained in the configuration section of this documentation.  Since these 
  17. files are displayed during a logon, a different quote will be displayed 
  18. everytime a user calls the system.
  19.  
  20. Here are the files that HMQuote MUST have in the current active directory to 
  21. work properly.  (Please remember that all text files must have the standard 
  22. CR/LF at the end of each line) :
  23.  
  24. QHEADER.HMY :  This text file contains the ASCII and ANSI header information 
  25. that will be put into the final quote files.  For example -
  26.  
  27. Quote for the day :
  28. -------------------
  29. :Ansi
  30.  [0;1;32mQuote For The Day :
  31.  [0;33m------------------- [1;37m
  32.  
  33. The above example Qheader.hmy file will take all lines before the :Ansi line 
  34. is encountered, and place them at the head of the ASCII quote file that 
  35. HMquote generates.  All text lines after the :Ansi line are then placed at the 
  36. head of ANSI quote file.  This format MUST be followed if you wish to change 
  37. the headers for HMquote.
  38.  
  39. QUOTES.HMY :  This is the actual text file of all the available quotes.  
  40. Obviously, you don't have to have just quotes in here.  For example, you can 
  41. put small bits of trivia, or important events in history here also.  Again, 
  42. Quotes.hmy must follow a strict format.
  43.  
  44. HMquote will ignore all the beginning lines that start with a semi-colon (;).  
  45. This is ONLY at the beginning of the file.  No remarks are allowed anywhere 
  46. else.
  47.  
  48. The next line must consist of a number.  The actual limit on this number has 
  49. not yet been determined.  This number is the number of active quotes that are 
  50. in your file.  HMquote will use this number to randomly pick one out of the 
  51. list.  You MUST make sure that this number is accurate.  If it is too high, 
  52. and Hmquote picks a number higher than the actual number of quotes that are 
  53. there, no quote file will be generated.
  54.  
  55. The rest of the file will be the quotes that HMquote will randomly choose 
  56. from.  Quotes can consist of more than one line.  If you wish to extend a 
  57. quote past one line, all extra lines MUST begin with a colon.  Otherwise, 
  58. Hmquote will look at is as the beginning of a new quote.
  59.  
  60. The last line of Quotes.hmy must be :Done.  This lets HMquote know that it is 
  61. officially the end of the file.  Anything after that line is simply ignored.
  62.  
  63. Here is a sample Quotes.hmy file :
  64.  
  65. ;Remember these lines will not
  66. ;be looked at by Hmquote.
  67. 3
  68. This would be the first line of quote #1
  69. :this would be the second line of quote #1
  70. This would be quote #2
  71. This would be the first line of quote #3
  72. :this would be the second line of quote #3
  73. :this would be the third line of quote #3
  74. :this would be the fourth line of quote #3
  75. :Done
  76.  
  77. As you can see with quote #3, these is no reasonable limit to the size of your 
  78. quotes.
  79.  
  80.  
  81. If HMquote is run successfully, two output files will be created, they are 
  82. QUOTEAS.HMY and QUOTEAN.HMY.  Quoteas.hmy is the ASCII text file that is 
  83. created, and Quotean.hmy is the ansi text file that is created.  Each on of 
  84. them consists of their respective headers as defined in Qheader.hmy, and the 
  85. quote that HMquote randomly chose.
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93. HMQUOTE, although a separate entity of Harmony BBS, is copyrighted with 
  94. Harmony BBS.  All applicable copyright laws relevant to Harmony BBS are also 
  95. extended onto HMQUOTE.
  96.  
  97. HMQuote (C)Copyright Concord Software 1992
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.