home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 3 / AUCD3.iso / airport / utils / olread / !OLRead / !Help < prev    next >
Text File  |  1997-08-10  |  20KB  |  485 lines
  1. OLRead vs 0.60, by Alex Hayward
  2. -------------------------------
  3.  
  4. OLReadS has been released! See below for details.
  5.  
  6. OLRead is an off-line message reader for ArcBBS. Drag a message file on to its
  7. icon on the icon bar to load it. If you run in to any difficulties then there
  8. are more detailed instructions below. If you still can't work out what is wrong
  9. contact me on Arcade, user #1260, or as Alex@hayward.u-net.com.
  10.  
  11. Note that an External Data Edit Protocol combatible editor such as StrongEd or
  12. Zap must be loaded to edit replies. OLRead can now automatically load an
  13. editor, providing that it has been 'seen'. In order for it to do so add the
  14. following line the beginning of the edtior's !Boot file (not OLRead's,
  15. although you can automatically run the editor from OLRead's !Run file if you
  16. wish):
  17.  
  18. Set Alias$@EditType_FFF <Zap$Dir>.!Run
  19.  
  20. Replacing Zap$Dir with program-name$dir for other editors. A similar name
  21. should be used earlier in the !Boot file at some point, so use that. If it
  22. isn't, try Obey$Dir.
  23.  
  24. This is actually part of the external data edit specification, but it doesn't
  25. seem to be used. Obviously, if its already present, you needn't bother.
  26.  
  27. Users of OLRead may be interested to hear of Dave Higton's program 'Switcher',
  28. available from Arcade. If loaded before your text editor (eg in your boot
  29. sequence) then it will intercept and ArcBBS message files you click on and
  30. send them to OLRead rather than your text editor. Users may also be interested
  31. in my own '!Magic' which appeared on the Acorn User August 1997 disc, which
  32. performs a similar function for a large and configurable set of types of file
  33. including ArcBBS scratchpads.
  34.  
  35.  
  36. Other points
  37. ------------
  38.  
  39. Some control over the formatting of quotes is available. I STRONGLY ADVISE
  40. you to use whatever is conventional for the board you are posting to. On
  41. Arcade (and many others) this means the default setting. You should also limit
  42. the size of your signatures to one or two lines for most BBSs and four lines
  43. for Usenet.
  44.  
  45.  
  46. Disclaimer
  47. ----------
  48.  
  49. OLRead is © 1995, 1996, 1997, Alex Hayward.
  50.  
  51. This software may be distributed providing that all files within it remain
  52. intact, (except for the '!OLRead.mess' and '!OLRead.sig' files which may be
  53. removed, if present) and that no charge whatsoever is made. This does not
  54. apply to beta test versions (identified by the word beta after the version
  55. number), which must not be distributed except by me. This is not a beta test
  56. version.
  57.  
  58.  
  59. The registered version, OLReadS
  60. -------------------------------
  61.  
  62. The registered version of OLRead contains all the features of OLRead plus:
  63.  
  64. • graphical and 'quick' thread following for easy messagebase navigation;
  65. • internal archiving (compressed) of message batches;
  66. • multi-user and multi-bbs ability;
  67. • searching;
  68. • the production of statistics about a message packet, such as the number of
  69.   posts by particular people;
  70. • an address book;
  71.  
  72. as well as many other small improvements.
  73.  
  74. To obtain a copy send your name, address and a cheque for 10 UK pounds to:
  75.  
  76. Alex Hayward,
  77. JCR,
  78. Norham Gardens,
  79. Lady Margaret Hall,
  80. Oxford OX2 6QA
  81.  
  82. If you wish to be contacted about future upgrades then please indicate your
  83. e-mail or Fidonet address. Such updates will also be advertised, where
  84. possible, on http://www.personal.u-net.com/~hayward/OLRead.html. Delivery by
  85. post is only possible within the UK, if you live outside the UK then please
  86. specify an e-mail address to which you want it to be sent.
  87.  
  88. As you may be aware there have been some stability problems with OLReadS, but
  89. these should be much improved after recent bug fixes. I would consider
  90. current revisions to be stable in normal use on my Risc PC 610. However, if
  91. you do find OLReadS to be unstable or unacceptably buggy with your setup so
  92. as to limit its usefulness then I will refund your money providing that you:
  93. return all discs and documentation which I have sent in connection with
  94. OLReadS, destroy all copies of OLReadS including back-up copies, provide me
  95. with a description of your system and the circumstances under which crashes
  96. or bugs occur and answer any reasonable requests for further information or
  97. crash trace files (I do not expect the last of these to be necessary for
  98. known bugs or crashes).
  99.  
  100.  
  101. Revision history
  102. ----------------
  103.  
  104. Changes since version 0.31
  105.  
  106. New views are now possible, and more than one file can be viewed at a time.
  107.  
  108. I have hopefully fixed a problem which causes OLRead to report that the
  109. replies are corrupt when saving from the reply list. Select save and unsaved
  110. options have been added to the menu as well.
  111.  
  112. When a message is saved back to OLRead after being edited the editing window
  113. now remains open, and the message is saved to disc. If you have finished
  114. editing either close the window or click on 'Cancel' in the OLRead's write
  115. message window. If you make any changes you can either keep them by saving a
  116. second time, or use the original reply by closing the window or clicking on
  117. 'Cancel'. Unfortionately, a bug in Zap means that I can not request it to
  118. mark the reply as saved (it hangs the desktop) so Zap will warn you about it
  119. being unsaved, even if you have just saved the reply.
  120.  
  121.  
  122. Changes since version 0.40
  123.  
  124. The message list format has been modified so that messages occupy only one
  125. line. This should make it easier to scan through.
  126.  
  127. Various configuration options have been added. Firstly, Close edit on save
  128. will mean that saving a reply will cause the external edit - and the write
  129. message window - to close automatically.
  130.  
  131. Secondly, more control is available over which signatures are added. For each
  132. type of area it is possible to have either no sig added, sig 1 added, or a
  133. random signature chosen out of the three available. Taglines are now
  134. available and are added automatically if the appropriate option is set here.
  135.  
  136. A default save path can be set. Whenever a save box is brought up to save
  137. messages for upload, this path will be automatically inserted. Either type in
  138. the path or drag the icon to the appropriate place.
  139.  
  140. Some more special fields are available in quote headers:
  141.  
  142. %subject
  143. %area (inserts the area the quoted post is in)
  144. %hour or %hour12 (inserts the time of the original message in hours using the 
  145.                   12 hour clock)
  146. %hour-24
  147. %am or %pm (inserts am or pm as appropriate)
  148. %minute
  149. %seconds
  150. %century
  151. %short-year or %year (inserts the last two digits of the year)
  152. %long-year or %full-year
  153. %short-month or %month (inserts the abbreviated month, eg Jan)
  154. %long-month
  155. %long-day (inserts the full name of the day, eg Monday)
  156. %short-day or %day
  157. %day-no (inserts the day of the month)
  158. %date (equivalent to %day-no %month %year)
  159.  
  160. %to (the name of the original recipient)
  161. %to1 (the first name of the original recipient)
  162. %from or %name
  163. %from1
  164.  
  165. This is in addition to %% to insert a %, %nl to insert a new line and %id to
  166. insert the message id (usenet messages only).
  167.  
  168. The Write Message window has been rearranged. Cancel is now delete, which is
  169. greyed out unless you save a message without the 'Close edit on save' option
  170. set, in which case it deletes the message completely. To cancel an edit,
  171. either close the write message window or the editor's window.
  172.  
  173. Taglines are now available. Shift-double click in !OLRead and load the file
  174. 'taglines' in to a text editor to view/change them. Each tagline is separated
  175. by a blank line.
  176.  
  177. Various new options and hot-keys have been added to the main menu which each
  178. set up the write message window in a slightly different way.
  179.  
  180.  
  181. Changes since version 0.45
  182.  
  183. Apart from (very) numerous bug fixes:
  184.  
  185. More quote header fields:
  186.  
  187. %to2   The surname of the recipient of the quoted message
  188. %from2 The surname of the sender of the quoted message
  189.  
  190. OLRead grabs the input focus after the end of an edit so that the arrow keys
  191. can be used to move between messages.
  192.  
  193. ^Q or the Quote button now quote the entire message if there is no selection.
  194.  
  195. Double clicking with adjust on a message in the message list now goes to the
  196. message and closes the message list. Double clicking with shift held down
  197. will automatically open a new view on to the message.
  198.  
  199. Closing the write message window now gives a warning before removing the
  200. message.
  201.  
  202. The reply and private flags in the write message window are no longer
  203. present. Select area zero (or set the netmail flag - the one before 'of') for
  204. private messages. Whether it is a reply or ot depends on how the edit was
  205. started, with edit reply, quote, or write message. Only the latter case is
  206. not a reply.
  207.  
  208.  
  209. Changes since version 0.46
  210.  
  211. A few more bug fixes. Automatic loading of editors added, support for OLE
  212. removed completely (it didn't actually work anyway...). Multiple
  213. simultaeneous edits should now be possible.
  214.  
  215. You may notice that its memory requirements are a little odd, eg load a large
  216. scratchpad and compare the change in the memory it uses to the size of the
  217. file. Don't worry about this, its supposed to happen.
  218.  
  219.  
  220. Changes since version 0.48
  221.  
  222. Support for outline fonts has been added, see the Choices window. Quoting has
  223. been tidied up a little.
  224.  
  225.  
  226. Changes since version 0.50
  227.  
  228. Plenty of bug fixes.
  229.  
  230. A second quote header for 'diverted' quotes posted to an area other than the
  231. one which contained the original message.
  232.  
  233. The line spacing used can be adjusted. The value you enter (which can be
  234. negative) is added to the default spacing for that font size.
  235.  
  236. It is now possible to view your list of replies, and to reedit them without
  237. loading any messages, see the icon bar menu.
  238.  
  239. Messages can also be written without having loaded anything, but you will have
  240. to enter numeric area numbers rather than choosing from a list of area names.
  241.  
  242.  
  243. Changes since 0.51
  244.  
  245. A few bug fixes. Some support for changing the templates:
  246.  
  247. If a template called 'banner' exists it will be displayed at start up until
  248. clicked on.
  249.  
  250. The hieght and width of the top pane can be changed, but make sure that you
  251. change the height by both reducing the Y size AND lowering the y coordinate
  252. of the origin by an equal amount. This will ensure that the header information
  253. is displayed in the correct place.
  254.  
  255. The right hand column in the top pane should not get overwritten, and the
  256. window should get wider if the entire text can't fit in the pane.
  257.  
  258. Finally, some alternative templates and sprites are available in the
  259. Temprites directory. To use them copy the Sprites, Sprites22 and Templates
  260. files inside the !OLRead directory (shift-double click on OLRead to open it).
  261.  
  262. See their individual ReadMe files for more details and attributions.
  263.  
  264.  
  265. Changes since 0.55
  266.  
  267. Miscellaeneous bug fixes, of which I do not have a complete record. Dragging
  268. off the top or bottom of the message display ow scrolls the window.
  269.  
  270.  
  271. ...and finally
  272.  
  273. As many (sensible) comments, bug reports, suggestions, details of other
  274. message formats (which I may consider implementing) as possible to Arcade
  275. user #1260, Alex Hayward.
  276.  
  277. Thanks go to Anton De Braal for a much better set of hi-res icons and to Mark
  278. Murray for supplying almost all of the taglines.
  279.  
  280. --------------------------------
  281.  
  282. Detailed Instructions
  283.  
  284.  
  285. Right, where shall I start... Apologies if any of this is out of date.
  286.  
  287.  
  288. Loading
  289.  
  290. OLRead only reads messages produced by version 1.64 of ArcBBS (or compatible
  291. software), although there shouldn't be any drastic side-effects with version
  292. 1.63. Only files of the type 'Text' will load - the type which almost all
  293. BBSs will send. If this is not the case then you should set the type as text
  294. first (I have seen some typed as 'Data').
  295.  
  296.  
  297. Moving around the message file
  298.  
  299. The video icons on the pane above the main window (where the messages are
  300. displayed) perform their usual actions. Two icons are provided to move to the
  301. previous/next area (top right) and a pop-up menu for jumping straight to a
  302. particular area. 'Read' and 'Skip read msgs', which are greyed out, are only
  303. available in the (unreleased) registered version. The leftmost writeable icon
  304. jumps to the nth in the batch, the 'Message id' icon searches for a message
  305. with a particular id IN THE CURRENT AREA.
  306.  
  307. Below this are various details about the message. Note that at present
  308. (10/8/97) ArcBBS will always say that there are no replies.
  309.  
  310. The left and right cursor keys move backwards and forward through the
  311. messages respectively, whilst the up and down arrows scroll the message.
  312. Ctrl-left/right goes to the first/last message, shift-left/right goes to the
  313. next/previous area and Ctrl-up/down goes to the top/bottom of the current
  314. message. Home and End (copy) move to the first and last message repectively.
  315.  
  316. Ctrl-L, 'Message list' from the menu or the list icon in the toolbox bring up
  317. a list of messages - double click on one to jump to it. Clicking menu brings
  318. up a list of areas, selecting one jumps to that area in the message list.
  319.  
  320. DJF tunes embedded in messages can be played by clicking on the first line.
  321. djf1 is supported.
  322.  
  323.  
  324. Extract
  325.  
  326. The 'Extract' submenu from the main menu leads to options to save either all
  327. of the message (with header and area name) or just the selected parts (no
  328. header or area). Ignore the UUcode - this is not yet implemented (and may
  329. never be).
  330.  
  331.  
  332. Writing messages
  333.  
  334. An External Data Edit Protocol compatible text editor, such as StrongEd or
  335. Zap, must be loaded otherwise an error will be returned.
  336.  
  337. Ctrl-W, 'Write messages' from the menu or the top icon on the toolbox bring
  338. up the 'Write message' window. 'Edit reply', or Ctrl-E (the Write message
  339. window need not be open for this), allows you to start editing a message.
  340. Quote (Ctrl-Q) quotes the selected text with the formatting as set up in the
  341. configuration window (see later). Editing will start automatically if you
  342. haven't started it already. Delete removes the message completely if it has
  343. been saved back to OLRead but editing is continuing, simply canceling the
  344. edit will discard any new changes but will not remove the message. To finish
  345. editing, use Save from the editor you are using.
  346.  
  347. Sign signs the message with one of the signatures defined with 'Sigs...' from
  348. the icon bar menu (see later). Opening the window up fully reveals various
  349. signing options. By default the signature used is no. 1 as defined for the
  350. type of area currently viewed. If configured on the 'Auto sign' option will
  351. be set (you can turn this off for individual messages if you wish) and a
  352. signature added automatically when editing has been completed. Auto sign is
  353. turned off when 'Sign' is used manually. Taglines are not yet implemented and
  354. for this reason the option is greyed out. Note that messages in a Usenet area
  355. which were originated locally and contain no Message-ID: line will not be
  356. recognised as usenet messages - the BBS local is used by default instead.
  357.  
  358. The top half of the window should be fairy obvious. The To: field can be set
  359. with the pop-up menu to 'All', 'ArcadeLink Email Gateway' (the Netmail option
  360. is automatically set) or the name of the sender of the message which was
  361. being viewed when this window was first called up. Sending netmails is
  362. achieved by turning on the option in fron of 'of' and entering the fidonet
  363. address in the adjacent icon.
  364.  
  365.  
  366. Changing replies
  367.  
  368. 'Edit replies' from the main menu, ctrl-R or the second icon in the toolbox
  369. bring up a list of all of the messages you have written so far. Single click
  370. with select selects a message, adjust can be used for multiple selections.
  371. Double clicking allows you to reedit a message.
  372.  
  373. Various operations can be performed on the selected messages. Edit, Delete,
  374. Select all and Clear selection do exactly what they say they do, with Edit
  375. being synonymous with a double click. Save allows you to save the selected
  376. messages only in a suitable format for uploading to the BBS. This is similar
  377. to the 'Save messages' item on the icon bar menu except that that saves all
  378. messages.
  379.  
  380. Some details about a message can be chaged during reediting, such as whether
  381. it is a reply or not, who it is to, whether it is a netmail, the subject and
  382. whether it is private or not.
  383.  
  384. This list of replies can also be brought up using the 'Reply list' option from
  385. the icon bar menu.
  386.  
  387. Editing signatures
  388.  
  389. Choosing 'Sigs...' from the icon bar menu brings up the 'Edit signatures'
  390. dialogue box from which you can choose which signature you wish to edit.
  391. 'Edit' starts editing - only one can be edited at a time. 'Cancel' cancels
  392. the current edit, use the close icon to close the dialogue box.
  393.  
  394.  
  395. Configuration
  396.  
  397. 'Choices...' from the icon bar menu brings up the configuration window. This
  398. is split in to several sections:
  399.  
  400. Message deletion. Replies can be automatically deleted as soon as you save
  401. them, when the next set of messages is loaded (you will always be prompted if
  402. some of these replies are not saved) or never. The last option, 'Delete when
  403. found in subsequent load' is not implemented and may never be. If prompt is
  404. set then you will be asked before ANY messages are deleted.
  405.  
  406. Auto sign. This allows you to select which of your replies will have a
  407. signature automatically added. You can override this option by deselcting the
  408. 'Auto sign' option in the 'Write message' window. Either sig no. 1 or a
  409. randomly chosen sig will be used, and a tagline will be added if the relevant
  410. option is set here. All of these can be overriden manualy using the bottom
  411. half of the write message window.
  412.  
  413. Quoting. The top half of this is applied to quotes from non-internet
  414. messages, the bottom to internet messages (e.g. usenet or Email Gateway
  415. messages) unless the 'Always use former method' icon is set. The quote header
  416. is added before a selection is quoted. A different quote header can be
  417. specified for when you are replying to a message, but posting your reply to a
  418. different area. They can contain some special fields:
  419.  
  420.   %name   The name of the sender of the messages being quoted
  421.   %nl     Inserts a new line
  422.   %id  (internet only) The ID from the Message-ID line
  423.   %%      Inserts a % sign
  424.   
  425.   %subject
  426.   %area   Inserts the area the quoted post is in)
  427.   %hour or %hour12  Inserts the time of the original message in hours using
  428.                     the 12 hour clock
  429.   %hour-24
  430.   %am or %pm Inserts am or pm as appropriate
  431.   %minute
  432.   %seconds
  433.   %century
  434.   %short-year or %year  Inserts the last two digits of the year
  435.   %long-year or %full-year
  436.   %short-month or %month  Inserts the abbreviated month, eg Jan
  437.   %long-month
  438.   %long-day  Inserts the full name of the day, eg Monday
  439.   %short-day or %day
  440.   %day-no  Inserts the day of the month
  441.   %date  Equivalent to %day-no %month %year
  442.   
  443.   %to  The name of the original recipient
  444.   %to1  The first name of the original recipient
  445.   %from or %name
  446.   %from1
  447.   %to2   The surname of the recipient of the quoted message
  448.   %from2 The surname of the sender of the quoted message
  449.  
  450. Others may be added at a later date.
  451.  
  452. For non-internet messages the number of spaces before the initials, and the
  453. number of initials included on each line of the quote can be set. I STRONGLY
  454. ADVISE you to use whatever method is normal for your BBS. This means 2
  455. initials and 2 spaces on Arcade (the original setting). If three initials are
  456. specified and there are only two for a particular message, an extra space is
  457. added to the beginning of the line.
  458.  
  459. The internet line prefix is added to the beggining of each line of the quote.
  460.  
  461. Toolbox. Sets whether the toolbox is, by default, displayed.
  462.  
  463. DJF playng. Sets whether DJFs (a sort of simple music format for messages) at
  464. the beginning and end of messages are automatically played. They can still be
  465. manually played by clicking on them.
  466.  
  467. The font used, and the point size, can also be set from this window. The line
  468. space offset given (which can be negative) will be added to the default line
  469. spacing for that font size.
  470.  
  471. There is an option to turn off compression, which is initially set in this
  472. release. Turning compression back on again will reduce the amount of memory
  473. that OLRead uses, will slow down loading and will have no apparent effect on
  474. the rest of the program (most things become very slightly faster). The
  475. compression is mainly intended for OLReadS in order to save disc space (by
  476. about a 30% reduction in the messagebase size), speed up the loading of
  477. messages from the archive on disc and to speed up searching.
  478.  
  479. Various other options are greyed out - they are only appropriate to the
  480. (unreleased, 8/3/96) registered version.
  481.  
  482. 'Cancel' removes the window without changing any settings, 'Reload' reloads
  483. the current defualts from disc, 'Save' saves them and sets them whereas 'OK'
  484. just sets them until the end of the session.
  485.