home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 2 / RISC_DISC_2.iso / pd_share / comms / netreader / !NetReader / !Help < prev    next >
Encoding:
Text File  |  1995-04-10  |  22.5 KB  |  444 lines

  1.                           HELP FILE FOR NET READER ©1994/5 Paul Vigay
  2.                           ~~~~~~~~~~~~~~~~~~~~~~~~
  3.                         
  4.                    v0.09 (BETA TEST)   LAST UPDATE - 10th Apr 1995
  5.  
  6. Copyright Notice
  7. ~~~~~~~~~~~~~~~~
  8. This application is SHAREWARE.
  9. You are free to copy and use !NetReader for a maximum of 14 days, providing
  10. you adhere to the following conditions.
  11.  
  12. a) All files remain the copyright of the author (ie. Paul Vigay)
  13. b) All files are copied in their entirety without any alteration.
  14. c) Usage of this application is entirely at the users own risk. No
  15.    responsibility will be taken for any loss or damage, financial or otherwise
  16.    which may arise from usage of this application.
  17. d) This application should NOT be distributed by Shareware or PD libraries
  18.    without my express written permission.
  19.  
  20. Permission is also granted for any user to freely copy this version of
  21. !NetReader,subject to the person(s) receiving it also obeying the conditions
  22. given above.
  23.  
  24. If you like !NetReader and continue to use it after 14 days, you should obtain
  25. your own registered copy by sending a cheque or postal order made payable to
  26. Paul Vigay, to 104 Manners Road, Southsea, Hants., PO4 0BG, England
  27. In return you will receive a registered copy and be eligible to receive
  28. updates to future versions. Registered users are also entitled to receive a
  29. copy of the full printed manual when it is complete.
  30.  
  31. You can also obtain the latest version (and support) by calling my bulletin
  32. board on (01705) 871531 (ANSI, 8N1) or Emailing me at pvigay@cix.compulink.co.uk
  33.  
  34. Purpose
  35. ~~~~~~~
  36. This application is designed for offline reading of Usenet messages 
  37. downloaded from CIX or other Internet servers. It should be compatible 
  38. with all Usenet message files using the "#! rnews" format (see below)
  39.  
  40. This Help file is intended as a short introduction to !NetReader, in order to
  41. 'get you going'. When I'm happy that !NetReader is nearing completion, I will
  42. produce a full printed manual which will be available free to registered users.
  43. Until then, I hope you can understand this file.
  44.  
  45. Users upgrading to a new version number are also advised to read the 'History'
  46. file contained within !NetReader.Docs directory. This details on-going changes.
  47.  
  48. Acknowledgements
  49. ~~~~~~~~~~~~~~~~
  50. Thanks are due to the following:-
  51. Acorn, for inventing the world's best computer.
  52. Dabs Press for writing ABC compiler (used to compile NetReader), the best Archie
  53. compiler available.
  54. Everyone at the Portchester Computer Club - for generally beta-testing my
  55. software.
  56. My girlfriend Jan, for endless cups of tea and putting up with my late night's 
  57. programming.
  58. Pink Floyd and Queen, for creating some excellent background music to program to.
  59. and anyone else whom I may happen to know, but forgot to mention.
  60. Fox Television, for producing The X Files - ideal viewing when not programming!
  61.  
  62. Instructions
  63. ~~~~~~~~~~~~
  64. Load !NetReader by double-clicking on it's icon in the directory viewer. It
  65. should then appear on the RISC OS icon bar after a few seconds.
  66.  
  67. Having downloaded your Usenet messages file from CIX (or elsewhere), you can
  68. simply drag the file onto this icon. !NetReader will then load and organise
  69. them so that you can read through them one at a time.
  70. Versions 0.07 and above will also read Archived source files - assuming that
  71. !SparkFS or !Sparkplug is already loaded.
  72.  
  73. The Usenet message file should be in the Rnews format. (see appendix a) If
  74. it is not, an error will be flagged.
  75.  
  76. Assuming that the import file is in the correct format, you may have to wait
  77. a few minutes for !NetReader to sort out all the messages and generate it's
  78. link tables. (See later for details on multi-tasking or non multi-tasking 
  79. loading)
  80.  
  81. When loading is complete, two windows will be displayed:-
  82.  
  83.           The CONTROL window and window containing the actual MESSAGE.
  84.                 
  85. The message window displays the first message in the file (minus all the
  86. header blurb at the top of it) and the control window shows origination
  87. details for the current message (ie the one in the message window).
  88. The control window contains several icons on the right hand side. These are:
  89.  
  90.        (graphic) LED: The LED, if illuminated, informs you that the current
  91.                       message contains a reference to you. The LED appears
  92.                       red if illuminated, otherwise it is grey for off.
  93.                 Last: Display the previous message in the file.
  94.                 Next: Display the next message in the file.
  95.                 Goto: Lets you select which message you want to display.
  96.                       (Clicking on this option gives a standard RISC OS
  97.                        menu, containing all the subject titles for the
  98.                        messages in the file. This may take a little while
  99.                        to display, depending on how many messages are in
  100.                        the file.)
  101.                        N.B. Any subjects highlighted in red indicate a 
  102.                        reference to your userID contained in the message.
  103.                 Reply: Opens an editable 'reply' window in which you can 
  104.                        type a reply message. (see below)
  105.                 Store: Store this message within !NetReader for later
  106.                        reference.
  107.         (graphic) Bin: Tag this message to be deleted when you Quit                                          !NetReader. NB. Closing the file (see below) will ask
  108.                        you for confirmation before deleting any tagged
  109.                        messages.
  110.                        NB2. If you delete ALL the messages then the message
  111.                        file will also be deleted.
  112.                        
  113. Above these four icons is shown the current message number, and the total
  114. number of messages in the file. Note, the message number is the position in
  115. the file and NOT the actual Newsgroup message number, which is displayed
  116. in the message window title bar.
  117.  
  118. The message window simply displays the text of the current message. Clicking
  119. SELECT will highlight any specific lines. Highlighting can be toggled on and
  120. off (by clicking SELECT) and is used when replying, to quote from the
  121. original message.
  122.  
  123. Clicking MENU in either the control window or the message window will display
  124. the same 'Main Menu'.
  125.  
  126. Message Threads (v0.07 and above)
  127. ~~~~~~~~~~~~~~~
  128. When reading messages, some may be replies to previous messages, while some may
  129. have replies to themselves. If the current message is referenced elsewhere in 
  130. the message file, the computer will open a small 'Thread' window, just
  131. underneath the CONTROL window. This has four functions:-
  132.  
  133. A 'Previous' option, allows you to find the previous message that the current
  134. message is a reply to. The 'Next' icon takes you to the next message given as
  135. a reply to the current message.
  136.  
  137. The 'Back' icon takes you back to the previous message. Using this icon, you
  138. can backstep through the previous messages.
  139.  
  140. Clicking MENU over the 'Thread' window, displays a menu (after a short delay)
  141. displaying all messages that are replies to the current message. SELECTing
  142. one of these will jump straight to it.
  143.  
  144. Clicking MENU whilst the mouse pointer is over either the control window or
  145. the message window will display the main menu:-
  146.  
  147. The Main Menu
  148. ~~~~~~~~~~~~~
  149. The Main Menu currently contains six options:-
  150.  
  151.         Export:     Export the current message as plain ASCII text.
  152.                     This opens a standard RISC OS save dialogue box.
  153.         Explode:    Allows you to automatically 'explode' the messages in the
  154.                     message file into individual files. NetReader will 
  155.                     automatically create filenames consisting of valid
  156.                     characters in the subject line.
  157.                     N.B. Duplicate names will automatically be numbered and
  158.                     new directories will be created automatically every 60
  159.                     messages. 
  160.                     As messages are 'exploded', they are also flagged for
  161.                     deletion, irrespective of their age.
  162.         New message Enter a new message either to the current news group, or
  163.                     a private message to the sender of the message you are
  164.                     currently reading.
  165.         Jump to...  This lets you jump to any message in the source file.
  166.                     N.B. This is the message in the file, entered by number,
  167.                     not the Newsgroup message or the message subject.
  168.                     (see above for going to messages by subject reference)
  169.         Search for: Allows you to enter a string to search for. !NetReader
  170.                     will then search through the entire message file until
  171.                     it finds a message that contains the target string.
  172.                     !NetReader will then display the relevant message.
  173.                     N.B. Search is NOT case-sensitive.
  174.         Quote:      This option is normally greyed out unless you have 
  175.                     opened the reply window by clicking on 'Reply' in the
  176.                     control window.
  177.                     If you are typing a reply, this option will simply copy
  178.                     any marked lines in the original message into your reply
  179.                     message. When it has made the copy, the original lines
  180.                     are automatically un-marked.
  181.         Utils:      Gives a sub-menu from which you can set flags for
  182.                     a range of messages as follows:-
  183.                           Tag:       Tag messages for deletion.
  184.                           Untag:     Mark messages NOT to be deleted.
  185.                           Read:      Mark messages as "Read".
  186.                           Unread:    Mark messages as "Un-read".
  187.                           Find self: Find the next message to have a
  188.                                      reference to your user ID in it.
  189.         Close file: Close this file, forgetting about any 'delete' tagged
  190.                     messages. After closing the file, clicking SELECT on
  191.                     the !NetReader icon will simply open the stored messages
  192.                     file.
  193.                     
  194. The Reply Window
  195. ~~~~~~~~~~~~~~~~
  196. The reply window contains a fairly primitive text editor by which you can
  197. type and edit your replies to messages. 
  198.  
  199. Dragging a text file into the reply window allows you to import ASCII text
  200. files into your reply.
  201.  
  202. The line length of replies can be adjusted via the 'Choices' window. (see 
  203. below)
  204.  
  205. You can move around by using the normal cursor keys, or by clicking SELECT
  206. on the mouse. There are also the following key functions:-
  207.  
  208.         f10         Delete line
  209.         Shift f10   Insert Line                    
  210.         Delete      Delete the character to the left of the caret.
  211.         Copy        Delete the character to the right of the caret.
  212.         Insert      Toggle Insert/Overtype mode
  213.         CTRL ⇦      Move to beginning of line
  214.         CTRL ⇨      Move to the end of the line
  215.         CTRL ⇩      Move to the bottom of the reply
  216.         CTRL ⇧      Move to the top of the reply
  217.         Shift ⇦     Jump to the previous word
  218.         Shift ⇨     Jump to the next word
  219.  
  220. The editor will word-wrap automatically if you type off the end of the line.        
  221. If you wish to enter a subject to include in the header information in your
  222. reply, click SELECT in the 'Subject' icon in the control window. This icon
  223. is writable, so that you can edit the subject. Leave it alone if you wish
  224. to quote the original subject.
  225.                     
  226. Clicking MENU when the mouse pointer is over the reply window will give you
  227. the 'Reply menu'. This is currently as follows:-
  228.  
  229.          Quote:     Quote lines from the original message (the same as on
  230.                     the main menu).
  231.          Sign:      Sign the message with your signature (see below) and
  232.                     close the reply window.
  233.          Send:      This will close the reply window, still adding the reply
  234.                     to the reply file, but without appending your signature.
  235.          Abort:     Forget the reply and close the reply window.
  236.          
  237. A number of settings in !NetReader can be customised to suit your tastes.
  238. This is done via clicking SELECT on the 'Choices' option on the icon bar
  239. menu.
  240.  
  241. The Choices window
  242. ~~~~~~~~~~~~~~~~~~
  243. Opening the choices window allows you some control over how !NetReader
  244. behaves when reading or replying to messages. There are a number of options,
  245. separated into different sections. These are all described below:-
  246.  
  247.          Username:           This icon should contain your full username.
  248.                              eg. pvigay@cix.compulink.co.uk
  249.                              It is used to include in the reply header to
  250.                              any messages you reply to.
  251.          Tab stops:          Sets the positioning of tab stops whenever
  252.                              ASCII character 9 is read when loading Usenet
  253.                              messages. This tries to ensure that signature
  254.                              lines appear correctly.
  255.          Multi-tasking:      Toggles multi-tasking loading on and off.
  256.                              If on, NetReader will multitask while loading
  257.                              a new file. If off, it will load approx 30%
  258.                              faster, although you won't be able to use the
  259.                              computer in the meantime.
  260.                              If you press ESCAPE during non-multitasking
  261.                              loading, then NetReader will revert back to
  262.                              multi-tasking mode. To cancel loading all 
  263.                              together, close the small red 'Loading' window.
  264.                              Obviously, while multitasking loading, do not
  265.                              close the import file or try loading another 
  266.                              file. If you do, NetReader will abort the load.
  267.  
  268. Stored messages:
  269.  
  270.          Delete after:       There are a number of icons here, that control
  271.                              the frequency of message purging on the stored
  272.                              files. !NetReader stores each message and thus
  273.                              can grow to become *VERY* large. !NetReader
  274.                              allows the option to automatically delete each
  275.                              message as soon as it becomes a certain age.
  276.                              To work, simply click on the relevant icons.
  277.          Auto cancel store:  If on, then the store message flag (see main
  278.                              control window) will turn off as soon you
  279.                              read each message. This is so that you need
  280.                              only store interesting messages and not store
  281.                              every message that you read.
  282.          Explode as:         Determines the maximum filename to use when the
  283.                              Explode option is used from the main menu.
  284.                              DOS will limit the filenames to 8 characters,
  285.                              whereas ADFS will allow up to 10 characters.
  286.                              
  287. Signature:
  288.  
  289.          Sign:               Enter a string here (max 255 characters)
  290.                              This string will be added to the bottom of each
  291.                              reply message when you click the 'Sign' option
  292.                              on the reply menu. Control characters can be
  293.                              added by use of |, followed by a letter.
  294.                              for example, to send a linefeed, enter |M.
  295.                              N.B. If you want the actual character | in your
  296.                              signature, enter ||.
  297.                              If you enter <longsig> as your signature,
  298.                              !NetReader will automatically use the file
  299.                              called !NetReader.Resources.longsig as your
  300.                              signature line. This allows for multi-line
  301.                              signatures.
  302.                              Obviously usage of this depends upon whether
  303.                              you have a .signature file on your internet
  304.                              host.
  305.        Add fortune cookie:   If this option is on (toggle by clicking
  306.                              SELECT) then a random 'fortune cookie' will be
  307.                              appended to your reply underneath your
  308.                              signature when you sign your reply.
  309.                              (See below for adding new messages)
  310.                              
  311. Replies (Replies is relevant to general replies sent back to Usenet news groups)
  312.  
  313.        Width of reply window:Lets you set the line width of your replies.
  314.        Auto wipe before      If this option is on, then when you reply for
  315.        first reply:          the first time after loading !NetReader, the
  316.                              replies file will be deleted. This ensures that
  317.                              replies from previous sessions don't keep
  318.                              extending the reply file.
  319.                              Of course, if you re-load !NetReader before
  320.                              uploading your reply file to Usenet you could
  321.                              end up overwriting it, so be careful how you
  322.                              set this value.
  323.        Reply file:           This allows you to set the destination file
  324.                              in which to store your replies. Drag as per
  325.                              usual RISC OS conventions.
  326.  
  327. Private replies:- These settings work in exactly the same was as for general
  328.                   replies (described above) but are for messages sent as a
  329.                   personal reply to a specific person.
  330.  
  331.                   N.B. Make sure that the 'Replies' and 'Private' filenames
  332.                   are different, or they will end up overwriting each other,
  333.                   thus losing your text.
  334.  
  335.         Save as default:     This will save the settings above back to disc
  336.                              so that next time you load !NetReader they will
  337.                              be the default values.
  338.          Cancel:             Cancel any changes and re-load the previous
  339.                              'default' file.
  340.          OK:                 Close the choices window without saving the
  341.                              choices back. Next time you load !NetReader,
  342.                              the original values will still be intact.
  343.  
  344. N.B. Some additional control is provided by editing some of the parameters 
  345. in the !NetReader.Resources.Messages file. However, these are more for the
  346. technical reader so a full description will be left out until I produce the
  347. full printed manual.
  348.                              
  349. Adding your own random quotes:
  350. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  351. Inside the !NetReader.Sigs directory is a file called "sigs". This is the
  352. file that stores all your 'fortune cookies'. You can use a normal text
  353. editor to add your own, as long as you separate each entry with a zero code.
  354. This can usually be done (in !Edit, at least) by holding down the Alt key
  355. and pressing 0 on the numeric keypad, then releasing Alt.
  356.  
  357. For the technically minded, !NetReader generates a random number between 0
  358. and the size of the "sigs" file. it then uses this number as a pointer into
  359. the file. !NetReader will then read 'backwards' until it finds a zero code
  360. and then read the quotes it finds until another zero is encountered (or the
  361. end of the file). Therefore quotes can be longer than one line, but don't
  362. have more than 80 characters on one line, or the end message may look funny.
  363.  
  364. Appendix A:
  365. ~~~~~~~~~~~             Usenet message file format
  366. Message files should be in the following format (either LF or CR,LF line
  367. terminated)
  368.  
  369. #! rnews 1511
  370. Article: 36614 of alt.alien.visitors
  371. Path: cix.compulink.co.uk!uknet!miclon!xmission!charnel.ecst.csuchico.edu!psgrain!rainrgnews0!news.teleport.com!ip-pdx1-08.teleport.com!vx
  372. From: some@one.com
  373. Newsgroups: alt.alien.visitors
  374. Date: Tue, 1 Nov 1994 02:47:21 +1000
  375. Lines: 19
  376. Message-ID: <vx.1485.037EB59E@teleport.com>
  377. NNTP-Posting-Host: ip-pdx1-08.teleport.com
  378.  
  379. This is a test message.
  380. #! rnews 1207
  381. Article: 36615 of alt.alien.visitors
  382. Path: cix.compulink.co.uk!uknet!miclon!xmission!charnel.ecst.csuchico.edu!psgrain!rainrgnews0!news.teleport.com!ip-pdx1-08.teleport.com!vx
  383. From: any@one.com
  384. Newsgroups: alt.alien.visitors
  385. Subject: Re: Aurora, Groom Lake, and Rosewell??
  386. Date: Tue, 1 Nov 1994 02:49:08 +1000
  387. Organization: Fragile Liquid
  388. Lines: 14
  389. Distribution: world
  390. Message-ID: <vx.1486.03805910@teleport.com>
  391. References: <391k9l$dde@usenetp1.news.prodigy.com>
  392. NNTP-Posting-Host: ip-pdx1-08.teleport.com
  393.  
  394. Another test message.
  395.  
  396.      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  397.  
  398. Future Enhancements
  399. ~~~~~~~~~~~~~~~~~~~
  400. This version is only a beta test version, so I hope to add lots more features
  401. as and when I get the time (and people give me feedback). To save duplicating
  402. requests, I have already planned the following improvements:-
  403.  
  404.     - Archiving of the saved messages file.
  405.     - The ability to drag and mark more than one line to quote in replies.
  406.     - More intelligent handling of replies, for example the facility to
  407.       forward to more than one newsgroup and controlling replies via
  408.       Followup-To: header line.
  409.     - An 'edit header' window to allow uses to customise the header info.
  410.     - A number of other features that I will probably only think up when I
  411.       start to use !NetReader for my own use.
  412.       
  413. Limitations
  414. ~~~~~~~~~~~
  415. Currently, !NetReader is restricted to the following limits. This should be
  416. ok for the time being, but I may re-arrange the memory management routines
  417. depending upon continued usage.
  418.  
  419.      Maximum number of lines in a single reply: 255
  420.      Maximum number of lines in original message(s): 1000
  421.           (Depending upon usage, I may decide to split messages longer than
  422.            1000 lines into several 'pages'. Obviously this limit may be
  423.            reached quicker if you encounter any uuencoded files in the
  424.            message file. Future versions may detect uuencoded files
  425.            automatically and give an extract file option, rather than display
  426.            the actual text, which is rather boring to read anyway!)
  427.      Maximum number of messages in source file: Approx 1000 - should be
  428.            enough for most users, unless you're a member of a rather lot of
  429.            news groups and don't log on that often.
  430.            
  431. User Comments
  432. ~~~~~~~~~~~~~      
  433. If you have any ideas/bug reports or general comments, please feel free to
  434. Email me via pvigay@cix.compulink.co.uk or log onto my bulletin board on
  435. (01705) 871531 (ANSI, 8N1) or post snail mail to the address given above.
  436.  
  437. !NetReader is ©Paul Vigay/Digital Phenomena.
  438.  
  439. Free Offer
  440. ~~~~~~~~~~
  441. The first fifty people to register their copies get a free Digital Phenomena
  442. pen. After that, they are available at 75p each (50p for the pen and 25p for
  443. postage)
  444.