home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / s1 / spraywall / !Spraywall / !Help next >
Encoding:
Text File  |  1997-03-09  |  13.4 KB  |  344 lines
  1.                 _  _____                                     _ _ 
  2.                | |/ ____|                                   | | |
  3.                | | (___  _ __  _ __ __ _ _   ___      ____ _| | |
  4.                | |\___ \| '_ \| '__/ _` | | | \ \ /\ / / _` | | |
  5.                |_|____) | |_) | | | (_| | |_| |\ V  V / (_| | | |
  6.                (_)_____/| .__/|_|  \__,_|\__, | \_/\_/ \__,_|_|_|
  7.                =========| |=================/ |==================
  8.                         |_|              |___/                   
  9.  
  10. © Werewolf Software 1997
  11. Written by Dane Koekoek
  12. Version 1.12 (16th February 1997)
  13.  
  14. Introduction
  15. ~~~~~~~~~~~~
  16. !Spraywall is an ARCbbs door which allows users to write a few lines of 
  17. `graffiti` for other users to see. It can be a sort of chat forum for short 
  18. messages and comments, or could also be used by the sysop to post a quick 
  19. announcement.
  20.  
  21. Using !Spraywall
  22. ~~~~~~~~~~~~~~~~
  23. Right, the first step to using !Spraywall is to copy !Spraywall out of this 
  24. archive and into your doors directory.
  25.  
  26. Next you need to set up a menu option for the spraywall.
  27.  
  28.   Example config for ArmBBS
  29.   ~~~~~~~~~~~~~~~~~~~~~~~~~
  30.   
  31.   defitem S
  32.   display `Spraywall`
  33.   help ` Write on the Spraywall`
  34.   [
  35.     door `1 10 <ArmBBS$Dir>.Doors.!Spraywall`
  36.   ]
  37.   enditem
  38.  
  39.   Example config for ARCbbs
  40.   ~~~~~~~~~~~~~~~~~~~~~~~~~
  41.  
  42.   DOING "Main Menu"
  43.   OSCLI "WimpTask <ARCbbs$Doors>.!spraywall"
  44.   DOOR 10
  45.   GOTO mainmenu
  46.  
  47. Right, next you need to configure !Spraywall. Go inside !Spraywall and load 
  48. up the Config file inside it. It'll look something like this:
  49.  
  50. =============================================================================
  51. BBS Name:The Werewolf BBS
  52. Door number:10
  53. Sillywall:No
  54. Sillyuser:Andrew Lobel
  55. Number of previous lines displayed:10
  56. Maximum number of lines to write in:3
  57. Name colour:32:B
  58. Wall colour:33:B
  59. Line colour:36:F
  60. Colours:Yes
  61. Colour char:~
  62. Fullnames:Yes
  63. Swear filter:Yes
  64. =============================================================================
  65.  
  66. The first two lines should be self explanatory - your BBS name and the door 
  67. number you're allocating for !Spraywall. The third and fourth lines are an 
  68. extra feature for the Spraywall. If sillywall is set to Yes then there is 
  69. a 1 in 15 chance that when someone writes in the Spraywall the user 
  70. specified as the sillyuser will write a line of complete junk!
  71.  
  72. The fifth line is an option to allow you to alter the number of lines 
  73. written previously !Spraywall displays. The more this number, the more 
  74. screens every user has to wade in through every time theey go to the 
  75. spraywall option on your BBS. The sixth line is for the maximum number of 
  76. lines a user can write in one go at the spraywall.
  77.  
  78. The seventh and eigth lines are the default ANSI colour codes for the 
  79. colour of the name of the user line, and the colour of the wall line. These 
  80. are minus the 3 that you normally find infront of ANSI codes, so are more 
  81. like ArmBBS colour codes really. The same codes are used for the colours 
  82. in the spraywall itself.
  83.  
  84. The ninth line is to turn on the exclusive colour-redefining routines in 
  85. the spraywall if it's set to yes, and the tenth line is to define which 
  86. character enables redefining of colours in the spraywall.
  87.  
  88. The eleventh line defines whether you wish lines to be stored with
  89. a prefix of "Dane Koekoek wrote on xxx" or "Dane wrote on xxx". With fullnames
  90. set to yes it uses the former, whilst anything else makes it use the latter.
  91.  
  92. Your next step is to try out the spraywall for yourself on your BBS. Then 
  93. try it out with your users and see what they think too! I hope you like it!
  94.  
  95. The last line allows you to turn on the built-in swear filter on. The default
  96. is on, and it will automatically chuck out any user who swears whilst in 
  97. !Spraywall. In addition to the built-in list of swear words, you can add your
  98. own. To do this, load the file SwearWords inside !Spraywall into your 
  99. favourite text editor and add any extra words you wish to ban. It is very
  100. important you leave no blank lines - the only line with nothing in it should
  101. be the final line.
  102.  
  103.  
  104. Extra features
  105. ~~~~~~~~~~~~~~
  106. If you press control-c at any of the prompts, !Spraywall exits back to the 
  107. BBS server.
  108.  
  109. If you press n or N at any of the `press any key` prompts, then !Spraywall 
  110. will go straight to the end and ask you to enter your message, without 
  111. reading the whole wall.
  112.  
  113. You can deny users access to the Spraywall by adding their names to the 
  114. file called TwitList. Possible causes to do this could be because they 
  115. constantly post annoying adverts for their BBS there.
  116.  
  117. There is a swear filter which chucks a user out if they swear on the wall 
  118. and then tells the whole BBS that they've been silly by posting up a strange 
  119. message about their personal tastes. :-) What they said is logged in a file 
  120. called OutLog inside !Spraywall to inform the sysop of what they've actually 
  121. been saying.
  122.  
  123. There's now the facility to add colours into the text when a user writes 
  124. in the spraywall. Standard ANSI colour codes apply here - try it out, 
  125. it's different. :-)
  126.  
  127.  
  128. History
  129. ~~~~~~~
  130. 1.00    First version. Written solely for use on The Werewolf BBS. Simply a 
  131.         better version than Chris John's spraywall, and also cured a few 
  132.         bugs in his.
  133.  
  134. 1.01    Changed a few things a bit. Had loads of complaints from users. :-(
  135.  
  136. 1.02    Finally sorted out a load of the bugs and got the program to work 
  137.         decently.
  138.         
  139.         Added in option to have more than one line, number of previous
  140.         lines shown and made it fully configurable. Released to John 
  141.         Stonier. :-)
  142.  
  143. 1.03    Tidied up a few things in the code. Fixed a major bug I just 
  144.         introduced (:-) ). Added the colours feature. Removed Stars option.
  145.  
  146. 1.04    Now made the colours feature an option, so you can turn it off if 
  147.         you or you users don't like it (though I can't see why! :-) ).
  148.  
  149.         Changed the key for the colours from the top to the bottom, cos you 
  150.         couldn't see the key when writing your line!!! :-)
  151.  
  152. 1.05    Now made it scan upto port 32 instead of 15 <ahem!>. Thanks Richard 
  153.         for sorting that silly out.
  154.         
  155.         Made memory usage work properly, so the wimpslot automatically gets 
  156.         larger as the Wall file gets larger. This has the disadvantage that 
  157.         if your Wall file has been in use for a very long period of time 
  158.         and has reached, say 200K, then the wimpslot of Spraywall will be 
  159.         200K bigger than it is with a blank Wall file. Cure for this - 
  160.         manage your Wall file every so often. 
  161.  
  162.         Sorted out the sillywall option so it actually does the silly 
  163.         lines - misplaced variable!
  164.  
  165. 1.06    Sorted out the config file handling so if sysops put wrong numbers 
  166.         in config it /should/ go to sensible figures. 
  167.         
  168.         Changed config file so there's an extra option for the colour of 
  169.         the lines going across.
  170.  
  171.         Changed numbers of colours so they're now try ANSI colours - ie 34 
  172.         instead of 4 for dark blue.
  173.         
  174.         Added :B or :F onto these lines for Bold or Feint colours for those
  175.         lines.
  176.         
  177.         It now checks for what type of terminal the user has and if they're 
  178.         not using an ANSI terminal then it chucks them out of the door.
  179.         
  180.         Three lines per session of writing is now the maximum due to the way 
  181.         the program has been designed.
  182.  
  183. 1.07    Control-I now gives a help page when in the door.
  184.  
  185.         Control-R redisplays the wall. 
  186.  
  187.         Read the help screen for full info on the keypresses supported.
  188.  
  189.         Added in legend to tell user to press Control-I to display the help 
  190.         screen.
  191.  
  192. 1.08    Tidied up a few things.
  193.  
  194.         Removed the dynamic memory stuff that I spent ages putting into 
  195.         the code! :-) Please note that you can delete past text written by 
  196.         holding down delete and it'll go up the line. However, it works 
  197.         okay on ArmBBS local login, but nowhere else does it seem to jump 
  198.         to the next line, but it does delete the text... Working on making 
  199.         it delete the text on screen too. :-) Sorted out a slight bug where 
  200.         the text kept on popping up for every time the help screen 
  201.         was viewed!
  202.  
  203. 1.09    Altered the `saving the user's contribution` procedure so that it
  204.         will NOT save anything if the user hasn't entered anything in,
  205.         OR if the user has just pressed the space bar (very common cause
  206.         of many blank lines in the spraywall).
  207.         
  208.         Made it now scan upto port 35, instead of just upto port 32, after
  209.         a request from Steve Pursey.
  210.  
  211. 1.10    The beginning of the month prompted me to notice that !Spraywall was
  212.         saving dates as "06th". A small change has been made so that it'll 
  213.         save them just as "6th" - just looks much nicer IMHO.
  214.  
  215.         Heading at the top saying "Now with colours! :-)" has been altered
  216.         to say "Now with colour :-)", with the "s" in "colours" being
  217.         removed and each colour being moved one along. This is so the "c"
  218.         in "colours" will display as a red, instead of a grey which some
  219.         terminals cannot display properly. This compromise was suggested
  220.         by Steve Pursey.
  221.  
  222. 1.11    Altered header bar to look nicer. Then altered it again so that
  223.         something like "Digital Databank BBS" would fit without creating
  224.         a blank line after it!
  225.  
  226.         Made a new config option in the Config file to define whether lines
  227.         are stored with a prefix of "Dane Koekoek wrote on xxx" or 
  228.         "Dane wrote on xxx". It used to store names as firstnames only,
  229.         of which currently the default is. With fullnames set to yes it uses 
  230.         the former, whilst anything else makes it use the latter. This feature
  231.         could be useful on larger BBS's where there might be many "Dave"'s 
  232.         contributing to the Spraywall!
  233.         ** Please add "Fullnames:Yes" or "Fullnames:No" to the end of your 
  234.         Config file inside !Spraywall. **
  235.  
  236. 1.12    Recoded the swear filter to make it much more efficient. There now is
  237.         a config option to turn the swear filter on or off:
  238.         ** Please add "Swear filter:Yes" or "Swear filter:No" to the end of
  239.         your Config file inside !Spraywall. **
  240.  
  241.         A file called SwearWords will be automatically created inside !Spraywall
  242.         when it is next loaded. This allows you to add extra swear words to
  243.         the swear filter to supplement the ones built-in. Open up the file and
  244.         add words to it, at the end. All words are checked in upper and lower
  245.         case, and with other characters nearby them. It is VITAL that no 
  246.         empty lines are left in this file, and the ONLY empty line must be 
  247.         the last line, which is just one single character return.
  248.  
  249.         Colours for the header changed, by request of Steve Pursey.
  250.  
  251.  
  252. Wish list
  253. ~~~~~~~~~
  254. Only a few things so far.
  255.  
  256.   • Maybe a sysop user interface for easy adding lines in the desktop.
  257.  
  258.   • Possibly changing it so that you can just read from when you last went 
  259.     into !Spraywall?
  260.  
  261.   • Changing it so you can press RETURN when you enter your lines and it 
  262.     goes onto the next line, and not exit the spraywall. What do people 
  263.     think?
  264.  
  265.   • Possibly having it so there's an option after reading the spraywall 
  266.     whether to write a line or to exit instead of going straight into 
  267.     writing a line and then exiting, or just exiting when you press return?
  268.  
  269.   • User-definable BBS-ads-and-other-unmentionable-items filter?
  270.  
  271.   • User-definable words for sillyuser option.
  272.  
  273.   • A message sent to the SysOp if there is an error - chucked out or swearing
  274.     on the wall.
  275.  
  276.   • Have option to add users to the TwitList if they get chucked out of the 
  277.     door.
  278.  
  279. Please tell me if you have any more suggestions of ideas or feel that any 
  280. one of the above ideas should really be implemented soon.
  281.  
  282.  
  283. Credits
  284. ~~~~~~~
  285. Quintin Parker for writing the fancy colour routines and for messing about 
  286. with my code, changing variable names and commenting on my programming 
  287. skills (?) :-) Also for testing it and for writing odd extra enhancements 
  288. to the code. :-)
  289.  
  290. John Stonier for giving this a good test on a true ARCbbs server, on a 
  291. busy BBS server.
  292.  
  293. Steve Pursey for testing it out on his BBS and giving many invaluable 
  294. suggestions.
  295.  
  296. Toby Mackenzie for nagging me for months to have a copy, and then when he
  297. got it giving no suggestions whatsoever of how to improve it! ;-)
  298.  
  299. David Coronel for showing me how to write a certain routine one way, with 
  300. the effect of me spending a whole evening trying to work out why it 
  301. wasn't working.
  302.  
  303. Malcolm Knight for rewriting this procedure so it did work properly! :-)
  304.  
  305. Richard Murray for sorting out a few bugs and for sorting out the port 
  306. number scanning one (:-) ).
  307.  
  308.  
  309. Problems
  310. ~~~~~~~~
  311. If you've got any problems with !Spraywall, or have any comments or 
  312. suggestions, then just contact me in any of the ways listed below.
  313.  
  314.  
  315. Werewolf Software
  316. ~~~~~~~~~~~~~~~~~
  317. Werewolf Software produce many quality products for Acorn computers
  318. including the excellent CDtracker & CDtracker Plus audio CD databasing
  319. and playing programs, and the new T.A.N.K.S. game. Please contact us
  320. using any of the ways listed at the end of this file for more information
  321. about us and our products.
  322.  
  323. !Spraywall is a freeware product, copyright Werewolf Software.
  324.  
  325.  
  326. Contacting me
  327. ~~~~~~~~~~~~~
  328. You can contact me or Werewolf Software in any of the following ways:
  329.  
  330. Email:
  331.   Dane Koekoek (#1) on The Werewolf BBS (+44-181-289 6003 * 24hrs * 33k6)
  332.  
  333.   Dane Koekoek@2:254/310 on FidoNet
  334.   dane@werewlf.demon.co.uk
  335.   
  336. Snail Mail:
  337.   Dane Koekoek
  338.   Werewolf Software
  339.   23 The Spinneys,
  340.   Bromley,
  341.   Kent,
  342.   BR1 2NT.
  343.   ENGLAND, UK.
  344.