home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / comms / m_z / netreader / !NetReader / !Help < prev    next >
Encoding:
Text File  |  1995-06-07  |  25.7 KB  |  520 lines

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