home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / internet / readnews / !Incorp / !Help < prev    next >
Text File  |  1994-04-07  |  10KB  |  209 lines
  1. !Incorp © 1992 Julian Wright
  2. ----------------------------
  3.  
  4. This application forms a part of my application !ReadNews and MUST NOT BE
  5. DISTRIBUTED SEPARATELY UNDER ANY CIRCUMSTANCES WHATSOEVER! So there! This
  6. application is subject to the same rules and conditions that are described
  7. in the help file for Readnews itself.
  8.  
  9. Right, now that's out of the way...
  10.  
  11. Purpose
  12. -------
  13. Incorp takes batches of news and email from Rucp and incorporates them into
  14. the structure that Readnews uses.
  15.  
  16. MessageTrans Module
  17. -------------------
  18. Incorp uses the MessageTrans module, for internationalisation purposes. If
  19. you are still running under RISC OS 2 and do not have this module, Incorp
  20. can still function but some text messages, most notably the interactive
  21. help ones, will not be available. MessageTrans is freely available but only
  22. from officially sanctioned sources, so I cannot provide it with Incorp. You
  23. may already have it though, as some Third-Party applications come with it.
  24.  
  25. Inside the !Incorp.!Run file, near the top, there are two lines which deal
  26. with loading MessageTrans if it is needed. If you have RISC OS 2 and have
  27. MessageTrans in your !System.Modules folder you should uncomment these
  28. lines to ensure it gets loaded.
  29.  
  30. RISC OS 3.00 users and higher need not worry about any of this - for you the
  31. module is already in your rom.
  32.  
  33. To use Incorp
  34. -------------
  35. Load !Incorp, and click on it's icon on the icon bar to start the
  36. incorporation process. This multitasks fully, where possible, unlike earlier
  37. versions. If the Verbose option is configured, then while Incorp is
  38. incorporating articles it's status window will be open, looking much like a
  39. RISC OS 3 filer_action window... :-)
  40.  
  41. There are two buttons on the status window while Incorp is incorporating,
  42. "Abort" and "Pause". The Abort button will halt Incorp in it's tracks. The
  43. Pause button will pause Incorp, and change into a "Continue" icon. Clicking
  44. on Continue will make Incorp carry on from where you last paused it.
  45.  
  46. When Incorp has finished processing, it removes the Abort and Pause buttons
  47. and replaces them with a single "OK" button, which simply closes the status
  48. window when you click on it. It then opens the Summary window, if it was
  49. not already open, or updates it if it was.
  50.  
  51. If Incorp tries to add an article to a 'full' newsgroup (ie one whose
  52. directory is filled to capacity already) then it will do one of two things
  53. depending on how it is configured. Either:
  54.   a) Delete the oldest article in the group and continue
  55. or
  56.   b) Pause, with two extra options visible in the status window:
  57.        Delete - Delete oldest article and continue
  58.         Quiet - Delete all further articles as necessary
  59.  
  60. At this point you also have the option of reading some of the articles
  61. with ReadNews, and deleting them there, after which point you can click
  62. on Continue to get Incorp to try again without deleting any articles of
  63. it's own.
  64.  
  65. Menus
  66. -----
  67. There are two - the iconbar menu and the Incorp menu, which can be accessed
  68. from the incorp status window. The Iconbar menu has the following options:
  69.  
  70.          Info: The usual info box.
  71.        Config: Leads to or opens the configuration window.
  72.          Quit: Hmm. I wonder what'll happen if I press this red butt...
  73.  
  74. The Incorp menu has the following options:
  75.  
  76.        Faster:  Speed up the process of incorporation at the expense of fast
  77.                 multitasking.
  78.        Pause:   Cause Incorp to pause when it reaches a full newsgroup.
  79.        Verbose: When unticked the status window will close; incorporation
  80.                 will continue.
  81.  
  82. Config Window
  83. -------------
  84. This window can be accessed from the iconbar menu. It has three distinct
  85. sections.
  86.  
  87. The icons in the top section determine whether incorp will scan for news, or
  88. email or both. Only on of these options can be chosen at a time.
  89.  
  90. The icons in the middle section are all miscellaneous ones:
  91.   Faster:
  92.     If selected this causes Email to be scanned faster, at the expense of
  93.     multitasking speed.
  94.   Auto Delete:
  95.     If selected then when a full newsgroup is encountered Incorp will delete
  96.     the oldest article in that group immediately (as it did in earlier
  97.     versions of the software). If unselected then Incorp will pause when it
  98.     encounters a full newsgroup, and give you a chance to deal with the
  99.     situation yourself.
  100.   Verbose:
  101.     If selected then the status window will pop up automatically when you
  102.     start an incorporation. If not, incorporation will commence silently.
  103.     You can still pop up the status window at any stage during incorporation
  104.     by clicking on the iconbar icon though.
  105.  
  106. The bottom section deals with the timer. Incorp can be set to start itself
  107. up every so often, and this section controls how often. (Or indeed if it
  108. happens at all). Note that regardless of the state of the Verbose option,
  109. a timer-initiated incorporation will not pop up the status window.
  110.  
  111. Summary Window
  112. --------------
  113. This window is opened whenever one or more of the following is detected:
  114.   - New news has just been incorporated
  115.   - New Email has just been incorporated
  116.   - There are new files in the UUCP Public directory
  117.  
  118. It contains up to three icons, depending on which combination of the above
  119. has been detected. Each icon has a counter underneath it, which represents
  120. the number of new postings, emails and files which have been received,
  121. respectively.
  122.  
  123. Clicking on either the news or email icons will cause ReadNews to load,
  124. while clicking on the file icon will open the public directory. Incorp
  125. will continue to register new files until you move or remove the files
  126. from the public directory.
  127.  
  128. Clicking with adjust will also close the summary window. Once the summary
  129. window has been closed, it's counters are reset and it will not be
  130. re-opened until there is more new stuff...
  131.  
  132. Version History
  133. ---------------
  134. <1.00 - Command line version of program, didn't multitask.
  135.  
  136.  1.00 - First multitasking version of Incorp (except for email) (1/5/92)
  137.  
  138.  1.01 - Email incorporation now multitasks (5/5/92)
  139.  
  140.  1.02 - Improved Faster mode - now it works even faster, and still keeps
  141.           the byte count updated properly.
  142.         Fixed problem with base creation causing an extra 'phantom' message
  143.           to be seen by the Newsreader. (10/5/92)
  144.  
  145.  1.03 - Added option to not scan for either news or email (25/5/92)
  146.  
  147.  1.04 - Fixed major bug... Incorp was locking up whenever an error occurred!
  148.           This didn't really bother me before, as errors are rare in my own
  149.           code 8^) But it was getting to be a bit of a pain, so the error
  150.           routine works now.
  151.         Incorp now handles news batches that aren't batches. That is, if
  152.           there is no '#! rnews' at the start Incorp assumes the whole file
  153.           is one article.
  154.         Re-worked the internals to make them neater. Implementing a pause
  155.           function when a newsgroup fills to capacity should be easy now.
  156.           Haven't tested the new code exhaustively though. (8/6/92)
  157.  
  158.  1.05 - Added configure window.
  159.         Amended library and application to make use of more RISC OS 3
  160.           facilities where available.
  161.         Incorp now pauses (if configured) when attempting to write to a
  162.           full newsgroup, rather than just deleting the oldest article.
  163.         New options while so paused: Delete and Quiet.
  164.         Wrote routine to remove leading "."s from the start of lines in
  165.           incoming Email messages, but commented it out as it doesn't
  166.           work yet.
  167.  
  168.  1.06 - Internationalised using MsgTrans.
  169.         Configuration options no longer have instant effect... they are
  170.           only noticed when Ok or Save buttons are clicked on.
  171.         Config window templates redesigned to place Save and Ok buttons on
  172.           a pane attached to the bottom right of the window.
  173.         Interactive help added.
  174.  
  175.  1.07 - Now renames batches currently being worked on in order to prevent
  176.           a simultaneous UUIO task from eg, adding new articles to an Email
  177.           file which Incorp is currently processing in RAM. Incorp would have
  178.           then simply deleted the email file and the new email would have
  179.           been lost.
  180.         Thanks to a routine supplied by Philip Bank