home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / kp2mn11.zip / KP2MNws.Doc < prev    next >
Text File  |  1996-08-22  |  8KB  |  207 lines
  1. KP/2 MaxNews V1.1 (C) Copyright Peter Schüller 1996
  2. ---------------------------------------------------
  3.  
  4. This product is FREEWARE, and you may use it as you wish.
  5. Modifyed versions of this program may NOT be distrubuted.
  6. All files in this archive (at least those listen in section 1.30)
  7. are not to be modifyed in a distributed archive.
  8.  
  9. Table of contents
  10. -----------------
  11.  
  12. 1.00) Release notes
  13. 1.01) How to install this program
  14. 1.05) Sample of the default KP2MNws.Ctl files (including explanations)
  15. 1.10) What do to, if you experience any problems using KP/2 MaxNews
  16. 1.20) How to contact the author
  17. 1.30) Files included
  18. 1.40) How to get the latest version
  19. 1.50) KP2MNws.Txt format
  20. 1.99) Errorlevels
  21. 2.00) What language is MaxNews written in?
  22. 2.50) Are there any other KP/2 products?
  23. 3.00) Who is the author?
  24.  
  25. 1.00 Release notes
  26. ------------------
  27.  
  28. KP/2 MaxNews V1.1
  29.  
  30. This is the second version of KP/2 MaxNews.
  31.  
  32. First of all: There has not been any MAJOR changes to this version of
  33. KP/2 MaxNews, only some changes to make it a bit configurable, the next
  34. version (if no major bugs are reported) will be totally re-written (see
  35. below) so this version is just a "stick-to-this-until-the-next-version"
  36. version.
  37.  
  38. KP/2 MaxNews still creates a
  39. .MEC file to be displayed to the users, only with some more configurability
  40. this time, but it's still nothing fancy, I am writing some routines that will
  41. enable me to let KP/2 MaxNews show the news to the users by itself, and when
  42. such a version is released, the program will be much more configurable (of
  43. course). All though, this program will be 100% rewritten quite soon (the
  44. thing about displaying the news itself...) I welcome all feedback, such as
  45. suggestions, comment or what ever. It can still be registred for free (see
  46. FreeReg.Doc) simply by sending me a message.
  47.  
  48. KP/2 MaxNews, is a newsmaker for Maximus for OS/2. It will read your
  49. news from KP2MNws.Txt, and create a MECCA file called KP2MNws.Mec. I don't
  50. know which versions of Maximus it will work on, but it should work on all
  51. versions, no advanced MECCA codes are used.
  52.  
  53. And as for system requirements, there aren't any specific, if you have
  54. Maximus up and running, this will work too :-). The EXE is 32-bit, so you
  55. have to have OS/2 2.0 or 2.1 or whatever version that was the first 32-bit.
  56.  
  57. 1.01 How to install this program
  58. --------------------------------
  59.  
  60. Simply UNZIP the KP2MNxx.Zip (where xx is the version number) into
  61. the directory where you want it (as you have already done, since you are
  62. reading this :-). Edit the KP2MNws.Ctl file.
  63. See ReadMe.Doc before using this product.
  64.  
  65. 1.05 Sample of the default KP2MNws.Ctl
  66. --------------------------------------
  67.  
  68. [blue on black]
  69. [white on blue]
  70. [lightgreen on black]
  71. [lightred on black]
  72.                              Continue? [[Y/n]
  73. NoLink
  74. misc\NewsAdd
  75. ------------------
  76.  
  77. KP/2 MaxNews configuration file, (C) Copyright Peter Schüller 1996
  78.  
  79. Here's the syntax:
  80.  
  81. Line 1: Color of the header.
  82. Line 2: Color of the text on the header (the topic that is)
  83. Line 3: Color of the text.
  84. Line 4: Color of the "Continue?" prompt.
  85. Line 5: The "Continue?" prompt string. Of course, you can add any MECCA
  86.         tokens on the line, it's put directly into the .MEC, without
  87.         any modifications.
  88.  
  89.  
  90. 1.10 What to do, if you experience any problems using KP/2 MaxNews
  91. -------------------------------------------------------------
  92.  
  93. If you experience ANY problems using KP/2 MaxNews, or if you have
  94. discovered a bug PLEASE contact me (see 1.20 for info on how to do that).
  95. I can't fix buggs if you don't tell me about them!
  96.  
  97. 1.20 How to contact the author
  98. ------------------------------
  99.  
  100. You can contact me (Peter Schüller) in the following ways:
  101.  
  102. Internet E-mail:
  103.    petersch@kuai.se
  104.    (Prefered)
  105. Fidonet Netmail:
  106.    Peter Schuller 2:206/139
  107.    (If you have access to E-mail, please use it, Netmail is slow and
  108.     not as reliable as E-mail, and it's messy...)
  109.  
  110. Snail mail is not available due to the possibility that the address will
  111. change, and that I don't have time to answer those...
  112.  
  113. 1.30 Files included
  114. -------------------
  115.  
  116.    If all of the files listed here are not included, plase se section
  117.    1.40 on how to get the lates unmodifyed archive.
  118.  
  119.       KP2MNws.Txt - News file with sample (sample in section 1.50 also)
  120.       KP2MNws.Exe - The OS/2 32 bit executable, the program to run when
  121.                     creating news
  122.       ReadMe.1st
  123.       ReadMe.Doc  - Read this before using this product
  124.       KP2MNws.Ctl - Default configuration file
  125.       FutHis.Doc  - Future/History of KP/2 MaxNews
  126.  
  127. 1.40 How to get the latest version
  128. ----------------------------------
  129.  
  130. I will upload the latest version to at least:
  131.  
  132.    ftp:      hobbes.nmsu.edu
  133.    ftp:      ftp.cdrom.com
  134.    telnet:   bbs.os2bbs.com (The OS/2 Shareware BBS, SysOp: Peter Norloff)
  135.  
  136. 1.50 KP2MNws.Txt format
  137. -----------------------
  138.  
  139. MaxNews.Txt contains the news you wanna create. This is the format used:
  140.  
  141.    Line #1: Date and/or Time
  142.    Line #2+: The news...
  143.  
  144. If you want more than one news-flash, put a line containing "//" between
  145. each news-flash. And always put a "//" on the last line of the file, and
  146. DON'T press <ENTER> afterwords. The reason for this is:
  147.  
  148. KP/2 MaxNews assumes that after a "//" there is either an EOF (end-of-file)
  149. or the next news-flash, if you press <ENTER>, KP/2 MaxNews will create an
  150. addtional header (the red line, with the topic).
  151. And if you don't put any "//" at all, you won't get a press-enter-prompt
  152. for the last news-flash, since KP/2 MaxNews puts the enterprompt, when
  153. "//" is discovered. Of course this will be fixed in later versions, but it's
  154. not by top priority :-)
  155.  
  156. 1.99 Errorlevels
  157. ----------------
  158.  
  159. This is a list of errorlevels returned by KP/2 MaxNews (the errorlevels are
  160. also written to Errors.Log).
  161.  
  162.    #     Description
  163.    0     Everything went fine, without any errors.
  164.  
  165.    1     "Unable to open KP2MNws.Ctl" - KP2MNws.Ctl (which should contain
  166.          your configuration) couldn't be opened. Make sure you have one.
  167.  
  168. 2.00 What language is MaxNews written in?
  169. -----------------------------------------
  170.  
  171. KP/2 MaxNews is compiled and written in IBM Visual Age C++ 3.0 for OS/2.
  172.  
  173. 2.50 Are there any more KP/2 products?
  174. --------------------------------------
  175.  
  176. Currently there are no more KP/2 products, but this is a list of products
  177. that will probably be released in the future:
  178.  
  179.    KP/2 MUtil - Will (probably :-) be a user-editor/maintainer/upgrader
  180.                 for Maximus, al thought all those features will probably
  181.                 not be avaliable in the first version.
  182.    KP/2 ***** - I haven't decided any name for it, but I will probably
  183.                 (depending on the development of Maximus - if it's needed)
  184.                 write a "FileDoor" for tagging/listing files, that will act
  185.                 as a file-menu by itself, except for maybe the uploads and
  186.                 downloads. (Of course, this won't be released for a while,
  187.                 if it's released at all)
  188.  
  189.  
  190. 3.00 Who is the author?
  191. -----------------------
  192.  
  193. I am a currently (1996) a 15 year "old" kid that lives in Uppsala, Sweden.
  194. I (as you might have guesed...) love programming C++, and OS/2, and hope to
  195. make some money out of it some time... But since I'm still in school, I don't
  196. have too much time to spend on programming (the good old TV needs some time
  197. too you know...) so the developments of KP/2 MaxNews and any other future
  198. KP/2 products will of course be slow as long as I'm still in school (which
  199. will be for several more years).
  200. I am also running my own BBS 24h/day that takes some time (no, the BBS is no
  201. distrubution site for the KP/2 products, not so far anyway).
  202. Err... I'm no good at telling stuff about my self so a guess that's it...
  203.  
  204.    / Peter Schüller
  205.  
  206.  
  207.