home *** CD-ROM | disk | FTP | other *** search
/ Really Useful CD 1 / ReallyUsefulCD1.iso / extras / comms / _reader / _help < prev    next >
Encoding:
Text File  |  1991-06-10  |  16.4 KB  |  372 lines

  1.           !Reader
  2.           -------
  3.  
  4. Here we go again! This is the basic version of my reader/replier 
  5. application for downloaded mail from ArcBBS bulletin boards. It has 
  6. been used on most of the UK BBSs successfully, but my phone bill is bad 
  7. enough without trying the overseas boards. It should be OK though, and 
  8. on any other ArcBBS boards present or future. Any problems or comments 
  9. you have about the application can be sent to me on TWoC (#332), Arcade 
  10. (#75) or Prestel (919999203). Please let me know if there are problems, 
  11. and describe them in as much detail as possible. I can't fix what I 
  12. don't know about!
  13.  
  14. Starting.
  15.  
  16. To use the reader, either double click on the icon to install it on the 
  17. icon bar, then drag a downloaded mail file over the icon, or call it 
  18. from the command line as *!Reader filename, where filename is an 
  19. optional downloaded mail file. This has been added at Hugos request to 
  20. allow ArcTerm 7 scripts to download mail and call Reader, it also 
  21. works with ArcComm 2. If you have !Spark 2.00 or later loaded, then 
  22. Reader will take care of extracting the text file from the Archive, 
  23. otherwise you will have to drag the text file out yourself. The program 
  24. will sort the text file to find the start of each message, and its 
  25. subject, then two windows will appear, one showing the first message in 
  26. the file and one containing nine icons above and to the right of the 
  27. message window.
  28.  
  29. Movement.
  30.  
  31.    In the top window, clicking on the "Prev" and "Next" icons with the 
  32. "Select" mouse button will take you forwards and backwards through the 
  33. messages (not necessarily in that order!), looping round at either end. 
  34. Using the "Adjust" button will reverse the direction, as on window 
  35. scroll symbols.
  36.  
  37.   "Jump" allows you to go directly to an area (click on its 
  38. name/number) and then to a particular message in the area (again click 
  39. on it). If you select an area with "Adjust" then the first message in 
  40. that area will be displayed. I've used windows rather than menus for 
  41. this, so use the scroll bars to shuffle through long messages and 
  42. lists. NB the areas window shows ALL the areas you have joined. Empty 
  43. areas are shown in a lighter grey and will not highlight on the list as 
  44. the mouse moves over them.
  45.  
  46.   A third way of moving through the file is to click on the slider 
  47. bar in the command window, the message closest to that point will be 
  48. displayed.
  49.  
  50. Replying.
  51.  
  52.    Clicking on "Send Reply" will open another window, titled to suit 
  53. the particular method you are using to reply. Having clicked "Send 
  54. Reply" the title will be along the lines of "Reply to message nnnnn in 
  55. Area nn". You can then type your message text in the window, editing as 
  56. needed. The usual edit keys apply, eg Ctrl-X deletes a marked section, 
  57. marking is done by clicking in the window with Adjust, Ctrl-V moves a 
  58. marked section, etc. Additionally, Ctrl-Y deletes the current line. 
  59. Marked text is shown in Green at the moment. Marked spaces become 
  60. little Green triangles. (How do you reverse the background when you are 
  61. using OS_WriteN?).  Clicking on "New Msg" produces a dialogue box, 
  62. select "message" or "mail". For a message, clicking on the arrows 
  63. beside the "area" field will cycle through the available areas. The 
  64. area box will be shaded if you have selected "Mail". "Recipient" is who 
  65. to send the message or mail to, "Subject" is hopefully obvious! The 
  66. reply window will appear when you click on the "OK" box, again keep 
  67. typing to enter the message. The defaults for the various fields are 
  68. taken from the currently displayed message. You may quote from several 
  69. originals in a single reply, although it will be flagged as a reply to 
  70. the first message if the reply was started as a Reply. (?! :->) If you 
  71. start another reply or message, or sign the reply you are working on, 
  72. or save the reply from the reply window menu, (still with me?) the 
  73. reply box will dissappear or clear to allow a fresh start. To re-edit a 
  74. saved reply, click on "Replies" in the message window menu. The reply 
  75. file will be searched for headers, and any found will be displayed in a 
  76. list. Click on the one you want to work on but note that it is DELETED 
  77. from the reply file when it is reloaded into the editor. You MUST 
  78. resave it if you want to keep it, even if no changes are made.
  79.  
  80. Voting
  81.  
  82.   Clicking on this button pops up a dialogue box with yes and no 
  83. options. Select which one, and click on OK to generate a vote.
  84.  
  85. Signatures
  86.  
  87.   "Sign" will put a tagline on the end of a message and save the 
  88. reply. The text for this tag is taken from the system variable 
  89. "Reader$Signature" (alter it in the !Run file) which is read when the 
  90. application is first run. Multiple line signatures can be made by 
  91. inserting a "|J" to force a new line, but note there is a limit of 255
  92. characters in total at present in the program, and Fido recommends a 
  93. limit of 40 so please be kind to your readers phone bills and keep it 
  94. short, or you will get Denis screaming at you in the Archimedes echo!
  95.  
  96. Quoting.
  97.  
  98.  To quote a previous message in a reply, click on the line or lines you 
  99. want to quote from in the message window which will turn the background 
  100. darker grey, then on the "Quote" button in the command window. If one 
  101. of the first three non-space character in a marked line is a '>' the 
  102. line is assumed to be already quoted, otherwise the first character of 
  103. the "From" line and either the next Upper case letter or the last 
  104. letter are used to form the marker. (eg my quotes will be AF>, anything 
  105. from Hugo would be marked HF>, Borris is Bs> etc). You can't quote the 
  106. message information lines, except the origin line in echo messages but 
  107. please don't or Denis will etc... (see earlier!), only the body of the 
  108. text. Clicking on the  "Quote" button in the command window will 
  109. transfer the marked lines from the message window to the reply window, 
  110. reformatting them and adding the markers. If the quoted lines are 
  111. already quoted, another '>' will be stuck on the end (ie HF> becomes 
  112. HF>> etc) and reformatted as necessary. You can mix quoted and original 
  113. lines in one go, the formatting will start a new line at each change of 
  114. marker and at every really blank line.
  115.  
  116. Saving Replies
  117.  
  118.   Replies can be saved by replying to another message, or signing the 
  119. current reply, or clicking on the "Save Reply" option in the reply 
  120. window. In the current "One step forwards, three steps back" 
  121. methodology I'm stuck with, the replies can ONLY be saved to 
  122. <Reader$Replies>.MailToAbbr, where Abbr is the abbreviation used to 
  123. recognise the board. Reader$Replies can be set in the !Run file but if 
  124. no pathname is supplied by you, the replies will go to the file 
  125. "<Reader$Dir>.^.MailToAbbr", ie the same directory as !Reader itself is 
  126. in. If !Spark 2.00+ is present then an attempt to Archive the files 
  127. will be made, which can occasionally lead to problems if a previously 
  128. existing non-archive file of the same name already exists. The un-arced 
  129. replies are in the file <Reader$Dir>.Replies in case of problems, 
  130. although this will be over written if you load in a new file of 
  131. messages or change the board name.
  132.  
  133. Extracting messages
  134.  
  135. If you want to save a message for future use, click menu over the 
  136. message window. A menu will appear leading to a standard Save box. Drag 
  137. the file icon as usual to a filer window, printer driver, etc., to save 
  138. the message.
  139.  
  140. Multiple reply files.
  141.  
  142. An option on the Icon bar menu leads to a sub-menu listing the bulletin 
  143. boards you use. These board names are held in the file 
  144. "<Reader$Dir>.ReplyList" and take the form "Board Abbr" where board is 
  145. the name of the BBS and Abbr is the short form of the name of the board 
  146. which will be used to create names for reply files for the outgoing 
  147. messages and also to identify incoming mail by board. The name and 
  148. filename are separated by a single space, and the entry for each board 
  149. must be on a new line. The board name should be 10 characters or less, 
  150. and the abbreviation 4 characters or less. "ReplyList" is only read 
  151. when !Reader starts up, so for any alterations to be included in the 
  152. menu you will have to quit and reload.
  153.  
  154.  If you rename a downloaded message file from the default "Scratchpad" 
  155. or whatever to something including the abbreviation (eg my files from 
  156. TWoC get called TWoCNov19 etc...) then the program will pick this up 
  157. and preselect the relevant board. If a reply file already exists for 
  158. that board then it will be loaded so you can halt a session part way 
  159. through and resume later, or reply to messages from more than one file 
  160. at once. If the board name isn't in the file name then the previously 
  161. selected board (or the first one on the list) will be used after a 
  162. warning.
  163.  
  164. !Spark version 2.00+ compatability.
  165.  
  166. If !Spark version 2.00 (or greater?) is loaded, !Reader will take care 
  167. of un-Arcing  the text file from a downloaded archive file. In 
  168. addition, the replies will be Arc'd to the selected reply file if the 
  169. selected board is changed or when the save option in the reply window 
  170. is selected or when the program is quit. !Reader will always try to Arc 
  171. the replies to save line time, so problems may arise from !Spark if an 
  172. un-Arced reply file exists.
  173.  
  174. Development History Highlights.
  175.  
  176. Changes to make version 0.51.
  177.  
  178.  Fixed a bug with messages over 100 lines crashing the application. 
  179. Long messages are now truncated after a warning.
  180.  
  181. Changes to make version 0.62
  182.  
  183. More error trapping is included, long files (1000+ messages), 
  184. non-message text files, and Archives with the wrong file-type are all 
  185. now catered for. !Spark 2.00+ compatability since v0.60. A second 
  186. messages file may be loaded without having to quit the application 
  187. first to prevent a crash. NB the replies file is still continued, and 
  188. the new messages file overwrites the old one. A merge capability may be 
  189. added at a later date.
  190.  
  191. Changes to make version 0.63
  192.  
  193. Sorted the slider bar overwriting the area and message list windows. 
  194. Call Wimp_GetRectangle AFTER the redraw routine, not before. HoHum...
  195. Added a Messages file to lose the default "Edit" title on some windows.
  196. After comments, I've made a new Icon. It still isn't wonderful, if 
  197. anyone has any better ideas.... The old one is still there BTW. It's 
  198. called !readerold. (No it isn't v0.90)
  199.  
  200. Changes to make Version 0.73
  201.  
  202. Added a new option to the icon bar menu to allow multiple reply files 
  203. to be held. (Versions 0.70 to 0.72 were intermediate and very bugged 
  204. attempts)
  205.  
  206. Changes to make Version 0.80
  207.  
  208. Rearranged the button window, and added "Vote" and "Sign" buttons. Also 
  209. tidied up a couple of things and removed one potential source of fatal 
  210. error type 5s I hope!
  211.  
  212. Changes to make Version 0.82
  213.  
  214. Found another possible source of fatal errors (When mallocing etc, make 
  215. sure you free it somehow before reusing the pointer!) Also removed (I 
  216. hope!) the restrictions on message size and file size, but note there 
  217. must be enough space on your disc for the un-arced message file and the 
  218. index file created by the program.
  219.  
  220. Changes to make Version 0.83
  221.  
  222. Fixed the spurious end of message bug caused by blank lines PROVIDED 
  223. you let the replies be saved when you quit the program or change the 
  224. board setting.
  225.  
  226. Changes to make version 0.90
  227.  
  228. Replaced the standard save mechanism so reply files always have spaces 
  229. added to blank lines, and are always Arced if !Spark 2.00+ is present. 
  230. Added reverse motion to the Prev/Next buttons. Default destination 
  231. directory for reply files has been re-instated. The files will go to 
  232. <Reader$Replies> if it is set, <Reader$Dir>.^ if not set. The third 
  233. icon to date has been added, thanks to Eddie (Arcade 1146)
  234.  
  235. Changes to make version 0.91
  236.  
  237. Tidied things up a bit, fixed various bugs reported in both this and 
  238. ReaderS. Added the extract message facility, and the capability of 
  239. reading spooled private messages, provided they have their ANSI codes 
  240. stripped.
  241.  
  242. Changes to make version 0.A0
  243.  
  244. Threw away all the Acorn txt routines which saved 40-50K of unsqueezed 
  245. progam space and included a dedicated reply editor instead. Fixed bugs 
  246. with Jump. I haven't made it crash since, but no doubt someone will!
  247.  
  248. Changes to make version 0.A1
  249.  
  250. Finished (I hope) the editor after not too many complaints, added file 
  251. import to the reply window, and message review. I think that Reader is 
  252. finished as far as I am concerned. Any thoughts?
  253.  
  254. To whet your appetites.
  255.  
  256. Something I've wanted to do since I started this is to follow message 
  257. threads forwards and backwards. There is a greyed out item on the icon 
  258. bar menu to set this up, but it isn't activated on uploaded versions of 
  259. Reader. There is however a version available from me at the address 
  260. below for the extortionate sum of Ten pounds sterling with this and 
  261. more, known as ReaderS. It is so much better, and improving all the 
  262. time. ReaderS also works with Cix conferences, and Unix style messages 
  263. are the next on the list.
  264.  
  265.  Anything more you want to see or any problems you get, or any orders 
  266. for ReaderS, please let me know on TWoC (#332) or Arcade (#75), 
  267. or...... Anthony Frost
  268.          10, Whiterocks Park
  269.          St Anns Chapel
  270.          Gunnislake 
  271.          Cornwall
  272.          PL18 9EF
  273.  
  274.  The money raised from the sale of ReaderS will be split equally 
  275. between the RNLI and Cornwall Air Ambulance, as I thought these are 
  276. charities many users could be in need of at some time but hopefully 
  277. never will! So far UKP 70 has been raised.
  278.  
  279.  
  280. Appendix A - Guide lines from Arcade BBS
  281.  
  282. Message: #2832
  283. Date   : Wed Jun 20 21:18:15 1990      
  284. From   : David Dade (#2)
  285. To     : David Coleman (#1)
  286. Subject: Uploading  messages with !Reader (reply to #2798)
  287.  
  288. I have just tested this out remotely from Hildenborough (Where's that?) and
  289. offer the following observations:
  290.  
  291. !Reader displays messages and generates automatically the header 
  292. required by the message uploader in ARCbbs. Having done this, it is UP 
  293. TO YOU to type your message in the required form - it's only an !Edit 
  294. window after all!
  295.  
  296. Firstly, if you are replying to a message you have just read, or are 
  297. now reading, you MUST click on [Send reply] *before* you type any reply 
  298. text, otherwise the header will be placed *after* whatever you have 
  299. just typed. If that was, in fact, the end of a previous reply then all 
  300. well and good, - otherwise the text between the blank line at the end 
  301. of one message and the header of the next will confuse the uploader and 
  302. be lost!
  303.  
  304. The term "blank line", by the way, means a line with only a newline 
  305. character in it (which in !Edit is an &0A - linefeed.) If you want to 
  306. include a line in a message that is "blank":
  307.  
  308. ^like this, you MUST put at least ONE space in it. An easy way to check 
  309. the contents of an !Edit line spacewise (ugh!) is to click the caret on 
  310. the very start of the text file, place the pointer somewhere near the 
  311. bottom of the screen and click the right-hand mouse button. All the 
  312. text and spaces will be highlighted (or rather lowlighted!) so you can 
  313. see if you have any blank lines where there shouldn't be any. If you 
  314. have more than one screenful of text, scroll to the bottom and click on 
  315. the right button again, which will highlight all the text. (There is 
  316. probably an easier way of doing this.) An unwanted blank line will 
  317. terminate your reply early, and the rest of the text will be lost.
  318.  
  319. Secondly - when doing new message [New Msg] don't forget to set the 
  320. button for Mail if it's private, and message and area number if it 
  321. isn't. The text format still applies here too of course. If you do make 
  322. a mistake and get a header generated in the wrong place, it's an easy 
  323. matter to edit it back into its proper place.
  324.  
  325. I hope these comments are useful and not too much like a lecture! If 
  326. Anthony (Frost) has any comments or corrections to what I've written, 
  327. do please put them up here.
  328.  
  329. DaviD
  330.  
  331.  
  332.  
  333.  
  334. Appendix B Upload format from The World of Cryton
  335.  
  336. Upload format
  337.   Upload message format  
  338.  
  339. + Uploading of messages now possible. BBS works out wether uploaded file
  340.   is ARCed or not (if it IS arced it will dearc the FIRST file in the
  341.   archive and take this as input to the handler).
  342.  
  343.   Uploaded files consist of records looking like this (terminated by EOF):
  344.  
  345.   <type> data
  346.  
  347.   For example to vote 'yes' on message 621, you would use:
  348.  
  349.   <vote> #621 Y
  350.  
  351.   To send private mail to Hugo Fiennes:
  352.  
  353.   <mail> ->Hugo Fiennes
  354.   subject
  355.   text (terminated with a blank line)
  356.  
  357.   To send public mail in area 5, as a reply to message 630 (ARCbbs will
  358.   pick up who the message is to from the original message):
  359.  
  360.   <msg> @5 #630
  361.   subject
  362.   text (terminated with blank line)
  363.           
  364.  
  365.   Public mail in area 5 to All (not a reply to anything):
  366.  
  367.   <msg> @5 ->All
  368.   subject
  369.   text (terminated with blank line)
  370.  
  371. Please mail me (Hugo) if you have any problems with this feature.
  372.