home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d595 / p-reader.lha / P-Reader / P-Reader.doc < prev    next >
Text File  |  1992-02-01  |  11KB  |  251 lines
  1. PRE1
  2.                           P - R E A D E R V5.2 
  3.  
  4.                                                                               
  5.    Yet another infernal Reader.  There are hundreds of them already, reliable,
  6.    comprehensive, user-friendly, sitting around pleading to be used.  So pick 
  7.    the Readers that will properly display texts with multiple colour and style
  8.    changes, compressed texts, ILBMs.   Now the list gets shorter!   Find the  
  9.    Readers that will also display animations and sounds. . . Finally find the 
  10.    Readers that will show illustrated texts, with pictures and animations     
  11.    mixed in with the words.   What, none?                                     
  12.                                                                               
  13.    Wrong.  One.                                                               
  14.                                                                                
  15.    First the general instructions.  press HELP for a summary.                 
  16.                                                                               
  17.  
  18.                              INSTRUCTIONS 
  19.                                      
  20.    Introduction
  22.       P-Reader can be used for:
  23.         All-purpose text reader.
  24.         Reader for special illustrated texts.
  25.         ILBM display, including HAM and cycling (where active).
  26.         Sounds (8SVX format).
  27.         ANIM5 type animation display.
  28.       
  29.       Texts, pictures and animations may be compressed (with P-Compress)
  30.   or uncompressed.  P-Reader will check and act accordingly.
  31.  
  32.       This reader forms the core of the complete P-Suite system.  Also included
  33.   in the Suite, and being released over the next few months,  are:
  34.  
  35.     P-Writer.   A matching text editor with special facilities for writing in
  36.                 colour and style changes and calling up illustrations.
  37.     P-Compress. Compression and de-compression tool.
  38.     P-Check.    Utility for checking suitability of IFF illustrations - ILBM
  39.                 and ANIM.
  40.     P-Animate.  Full-featured 3-D animation programme.
  41.  
  42.   Calling
  43.       From CLI:   P-Reader <FILE>
  44.          if no file is given P-Reader will open showing a file requester.
  45.  
  46.       From Workbench:  Click the icon. 
  47.          P-Reader will again open with a file requester.
  48.          To open with a file (may be a text, picture, sound, or animation),
  49.            hold <SHIFT> click the P-Reader icon, double-click the file icon.
  50.  
  51.     If you have Arp Library installed the standard Arp file requester will   
  52.   be used.
  54.   Operation
  55.  
  56.      P-Reader is mainly controlled by the ten function keys.  To produce a key 
  57.   strip index switch the printer on and click twice on the strip below with
  58.   the RIGHT mouse button to print it.  Cut out, join, print "P-Reader" on the 
  59.   back and enclose between two strips of clear Con-Tact film.
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66. #! 1 1 15 0 reader.key
  67.  
  68.    F1: Move to Page [n].  To move to any page press <F1>, enter the number of 
  69.    the required page, press <RETURN>.
  70.  
  71.    F2, F3: Press <F2> or <F3> to get the first or last pages respectively.
  72.  
  73.    F4: Search.  Requester will appear.  Click on this and replace the word
  74.    "text" with the string  that you want to find.  Set case-sensitivity and
  75.    press <RETURN>.  The  search will always start at the beginning of the file.
  76.    A cursor will appear immediately before the required string.
  77.  
  78.    F5: Search again.  Search will continue from the last instance found.
  79.  
  80.     WARNING The Search window must remain active during the search process    
  81.    If your pointer automatically activates the window over which it is placed,
  82.      make sure that it remains over the Search window.                         
  83.  
  84.    F6: Print page.  The current page will be dumped to the printer.
  85.  
  86.    F7: Print file.  The whole file will be dumped.
  87.  
  88.    F8: Screen to back.  Since P-Reader opens its own screen & window, depth or
  89.    window shrinking gadgets are not useful.  <F8>, together with  <Amiga-N>
  90.    <Amiga-M> allow any screen to be brought up.
  91.  
  92.    F9: Load.  Brings up a file requester.  A new file can be selected at any
  93.    time.
  94.  
  95.    F10:  Save.  Brings up the file requester again.  The text will always be   
  96.    saved in normal un-compressed ASCii form.  ILBM illustrations in the text
  97.    will not be saved (but see below under "ILBM Display).  
  98.  
  99.    If you do not have the Arp library, a simple string gadget requester will
  100.    appear.  Enter the required file, press <return> and click <OK> or <CANCEL>.
  101.         
  102.    Additional functions are performed by page header gadgets. From left to 
  103.    right:
  104.  
  105.       Window close - terminates P-Reader.  
  106.       Page up      - just click on it (L mouse button).
  107.       NoP          - No Pictures. Toggles to suppress or enable graphics.
  108.                         Click it.
  109.       NoC          - No Cycling.   Toggles to suppress or enable cycling.
  110.       Page Down    - Just click on it.
  111.     
  112.    The secondary functions of some keys of the numeric pad are activated:
  113.  
  114.       Home  (7)   - move to page 1.
  115.       End   (1)   - move to last page
  116.       Pg Up (9)   - move to previous page
  117.       Pg Dn (3)   - move to next page. 
  118.  
  119.  Window Size
  120.  
  121.     To make it possible to include illustrations a displayed P-Reader text has 
  122.   a set page size - no scrolling.
  123.     As a simple text reader P-Reader opens a screen matching the current
  124.   display mode.  If however an illustrated file is loaded, a PAL (256 line) 
  125.   or NTSC (200 line) screen will be used according to detail in the file
  126.   header.
  127.  
  128.  ILBM Display
  129.  
  130.     To stop cycling click with the LEFT mouse button.
  131.   
  132.     To dump to the printer place the pointer over the illustration and click
  133.   twice with the RIGHT mouse button.
  134.  
  135.     P-Reader can be used as a stand-alone ILBM viewer.  In this role it will
  136.   accept any of the standard view-modes and screen depths.  
  137.  
  138.     To start cycling press <TAB>.
  139.     To stop cycling click once with the LEFT mouse button.    
  140.     To dump to the printer click twice with the RIGHT mouse button.
  141.     To close the screen click once with the LEFT mouse button.
  142.  
  143.  ANIMATION Display
  144.  
  145.     ANIM5s (as produced by DPaint, Videoscape, P-Animator, etc) can be shown
  146.   either as text illustrations or by themselves.  The animation will display
  147.   its opening screen while loading.
  148.  
  149.     To start the animation click the LEFT mouse button once.
  150.     To end the animation click again.
  151.     When used as an illustration the animation must be run (a double-click
  152.   suffices) before you can move on to the next page.
  153.     Displaying large animations usually needs 1 Meg of memory.  Click on the
  154.   NoP gadget above if you have less.
  155.  
  156.  
  157.                            ILLUSTRATED TEXTS 
  158.  
  159.      The preparation of illustrated texts for P-Reader is much easier with 
  160.    P-Writer, its partner in the P-Suite stable.  However P-Writer is not
  161.    essential.
  162.  
  163.  Colour and Style Changes
  164.    The normal escape codes are used.    The most useful being:
  165.    reset   ^[[0;40m        b'ground Pen1  ^[[41m     style bold    ^[[1m
  166.    text Pen1   ^[[31m      b'ground Pen2  ^[[42m     style italic  ^[[3m 
  167.    text Pen2   ^[[32m      b'ground Pen3  ^[[43m     underline     ^[[4m
  168.    text Pen3   ^[[33m
  169.  
  170.    The initial ^[ represents the insert introducer or CSI, the non-printing
  171.    character produced by 'Esc'.  Refer to the instructions for your text
  172.    editor to see how to insert this.
  173.  
  174.  Three types of graphics (four if you count sounds) can be called :
  175.  
  176.  ILBMs (IFF pictures)                        
  177.    True ILBMs produced by DPaint or any of the standard drawing software can
  178.    be used, provided that:
  179.  
  180.      Size is no greater than 640 X 256 (PAL) or 640 X 200 (NTSC).
  181.      No HAM or HALFBRITE.
  182.      Depth is three planes (eight colours).
  183.  
  184.    The picture shares a screen with the text, so the palette used by the
  185.    picture will affect screen colours.  Wherever possible the first four 
  186.    colours of the picture should be close to 000, FFA, 3F3, F20.  The rest of
  187.    the default palette is 45F, FC8, A60, 0A0.
  188.  
  189.       Calling syntax:  (do not leave any space between # and !)
  190.              <#><!> 1 [Left edge] [Top edge] [Cycling] [File]
  191.              (Cycling: ON insert 1,  OFF insert 0)
  192.  
  193.    The sequence may be placed anywhere on the page, but is best put at the
  194.    bottom so that all text is displayed first.  Any text after # followed by !
  195.    is not displayed. 
  196.  
  197. ANIMATIONS                                     
  198.                                                     
  199.    This version supports straightforward ANIM5 animations as produced by
  200.  DPaint, Videoscape, The Projector, P_Animator and others.  Full information on
  201.  how to create animations for P-Reader will be given in P_Animator.    
  202.  
  203.    The command syntax is:   <#><!> 2 0 0 0 [File]           
  204.                                
  205.    The sequence can go anywhere on the page.  There should be no text directly 
  206.  under the anim.
  207.  
  208.   UP TO THREE ILBMs OR ONE ANIM MAY BE CALLED ON EACH PAGE
  209.  
  210.  SOUNDS
  211.  
  212.    Sound effects can be included if they are in the normal 8SVX format.      
  213.  
  214.      Command syntax:  <#><!> 4 [File]
  215.  
  216.  BORDERS
  217.  
  218.    Provides a standard Intuition Border which may be used to enclose text or 
  219.   pictures.  
  221.      The command syntax is:
  222.               <#><!> 3 [Left edge] [Top line] [Width] [Height] [Pen] 
  223.  
  224.    The command sequence may be placed anywhere on the page, however to prevent 
  225.   the border from being over-written by text it is best put on a line below
  226.   where the  border will appear. 
  227.    
  228.  Identification
  229.  
  230.   To identify an illustrated text write the letters PRE at its very start,
  231.   followed immediately (no blank spaces) by 0 to indicate a PAL file or 1 for
  232.   an NTSC file.  
  233.  
  234.                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  235.  
  236.   Credit:  Yuppee sound stolen from Nic Wilson's SAM sound-reader. 
  237.  
  238.   P-Reader may be freely copied and circulated in whole or in part, provided 
  239.   that any distribution is accompanied by this file.   The programme may be
  240.   used for any non-commercial or non-profit-making purpose.  Authority for
  241.   commercial or profit-making purposes may be obtained from the author -
  242.   proposals for payment in kind will be looked on favorably. 
  243.  
  244.   Reactions, suggestions, bug-reports all welcome.
  245.  
  246.   A.M.H Wyndham
  247.   1265 Canning Mills Road,
  248.   Roleystone,
  249.   WA 6111
  250.   Australia
  251.