home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / internet / netreader_1 / !NetReader_!Help < prev    next >
Encoding:
Text File  |  1994-12-19  |  22.3 KB  |  433 lines

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