home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d9xx / d924 / p-reader.lha / P-Reader / P-Reader.doc < prev    next >
Text File  |  1993-10-07  |  14KB  |  312 lines
  1. PRE1
  2.                           P - R E A D E R V7.1 
  3.  
  4.  
  5.                              INSTRUCTIONS 
  6.  
  7.                                                                               
  8.    Yet another infernal Reader.  There are hundreds of them already, reliable,
  9.    comprehensive, user-friendly, sitting around pleading to be used.  So pick 
  10.    the Readers that will properly display texts with multiple colour and style
  11.    changes, compressed texts, ILBMs.   Now the list gets shorter!   Find the  
  12.    Readers that will also display animations and sounds. . . Finally find the 
  13.    Readers that will show illustrated texts, with pictures and animations     
  14.    mixed in with the words.   What, none?                                     
  15.                                                                               
  16.    Wrong.  One.                                                               
  17.                                                                                
  18.    Press HELP for a summary of the instructions.                              
  19.                                                                               
  20.  
  21.    Introduction
  23.     P-Reader is really three readers in one:
  24.  
  25.      Normal Text reader.                                               Line 20
  26.      Illustrated Text reader - containing pics,animations, sounds.     Line 104
  27.      IFF reader - displaying ILBM pics, Anim5 animations, 8SVX sounds. Line 137
  28.       
  29.       Texts, pictures and animations may be compressed (P-Compress normal or
  30.   SuperC) or uncompressed.  P-Reader will check and act accordingly.
  31.  
  32.     Operation
  33.  
  34.      P-Reader is mainly controlled by the ten function keys.  To produce a key 
  35.   strip index switch the printer on and click twice on the strip below with
  36.   the RIGHT mouse button to print it.  Cut out, join, print "P-Reader" on the 
  37.   back and enclose between two strips of clear Con-Tact film.
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44. #! 1 1 16 0 reader.key
  45.  
  46.  
  47.      A number of programs intercept the F keys and use them for other tasks.
  48.   If you find that your function keys do not give the expected response you
  49.   can use LSHIFT-1 in place of F1, LSHIFT-2 for F2, and so on - LSHIFT-0
  50.   replaces F10.
  51.    
  52.  
  53.    NORMAL TEXTS 
  54.  
  55.   Calling
  56.  
  57.    From a CLI type P-Reader <FILE>.  If no file is given P-Reader will open
  58.   showing a file requester.
  59.  
  60.    From Workbench there are a number of ways of setting P-Reader to work:
  61.  
  62.      Double-click the P-Reader icon. P-Reader will again open with a requester.
  63.  
  64.      Enter P-Reader as the default tool in the text's icon.
  65.  
  66.      Use 'extended selection' - click the P-Reader icon, press and hold SHIFT
  67.     and double-click the text file icon.
  68.  
  69.     If you have Arp Library installed the standard Arp file requester will   
  70.   be used.
  72.   Operation
  73.  
  74.    F1: Move to Page [n].  To move to any page press F1, type the number of 
  75.    the required page, press RETURN.
  76.  
  77.    F2, F3: Press F2 or F3 to get the first or last pages respectively.
  78.  
  79.    F4: Search.  A requester will appear.  Click on this and replace the word
  80.    "text" with the string  that you want to find.  Set case-sensitivity and
  81.    press RETURN.  The  search will always start at the beginning of the file
  82.    and a cursor will appear immediately before the required string (if found).
  83.  
  84.    F5: Search again.  Search will continue from the last instance found.
  85.  
  86.    WARNING The Search window must remain active during the search process     
  87.    If your pointer automatically activates the window over which it is placed,
  88.    make sure that it remains over the Search window.                          
  90.  
  91.    F6: Print page.  The current page will be dumped to the printer.
  92.    F7: Print file.  The whole file will be dumped.
  93.  
  94.    F8: Screen to back.  Since P-Reader opens its own screen & window, depth or
  95.    window shrinking gadgets are not useful.  F8, together with  Amiga-N or
  96.    Amiga-M allow any screen to be brought up.
  97.  
  98.    F9: Load.  Brings up the file requester.  You can select a new file at any
  99.    time provided it is a normal text file.  For illustrated files or IFF close
  100.    P-Reader and start again.
  101.  
  102.    F10:  Save.  Brings up the file requester again.  The text will always be   
  103.    saved in normal un-compressed ASCii form.  
  104.  
  105.    If you do not have the Arp library, a simple string gadget requester will
  106.    appear.  Enter the required file, press <return> and click <OK> or <CANCEL>.
  107.         
  108.    More functions are performed by page header gadgets. From left to right:
  109.  
  110.       Window close - terminates P-Reader.  
  111.       Page up      - Click it to get the previous page.
  112.       Palette      - Click to cycle through available colors.
  113.       Page Down    - Just click it.
  114.     
  115.    The secondary functions of some keys of the numeric pad are also activated:
  116.  
  117.       Home  (7)   - move to page 1.
  118.       End   (1)   - move to last page.
  119.       Pg Up (9)   - move to previous page.
  120.       Pg Dn (3)   - move to next page. 
  121.  
  122.  Scrolling
  123.     
  124.     Hold LMB down to scroll down; RMB scrolls up.  Press LSHIFT to toggle the
  125.   scrolling speed.
  126.  
  127.  
  128.   IFF FILES 
  129.  
  130.    Pictures (ILBMs of all types including HAM), animations (Anim5 only) and
  131.   sounds (8SVX format) can be shown - or sounded.  Call them in exactly the
  132.   same way as you would call a normal text.  
  133.  
  134.  ILBM Display
  135.  
  136.     To start cycling (if active) press the TAB key, to stop it click the LEFT
  137.  mouse button.
  138.  
  139.     To dump to the printer place the pointer over the illustration and click
  140.  twice with the RIGHT mouse button.  Requester will ask for confirmation.
  141.  
  142.     To close the screen click once with the LEFT mouse button.
  143.  
  144.  ANIMATION Display
  145.  
  146.     ANIM5s (as produced by DPaint, Videoscape, P-Animator, etc) can be called 
  147.    and will display the opening screen while loading.  A switch -r can be used 
  148.    to set the framing rate in frames/second; default is 7 frames/sec.  
  149.  
  150.         eg:    P-Reader dh0:Marilyn -r12
  151.  
  152.     From Workbench enter RATE=12 in the Tool Types section of the icon used to
  153.   call the animation.
  154.  
  155.     To start the animation click the LEFT mouse button once, to end it click
  156.   again.  It will be run in continuous mode - starting again at the beginning
  157.   each time it gets to the end - if the animation was not designed for this
  158.   the second run may look very peculiar indeed.
  159.  
  160.  
  161.   ILLUSTRATED TEXTS 
  162.  
  163.      Illustrated texts for P-Reader can be identified by the letters PRE at the
  164.    start of the file followed by a number (1 indicates that a PAL page size
  165.    will be used, 2 for NTSC).  They are called in just the same way as the
  166.    other types of file - P-Reader will see the PRE code and act suitably.
  167.  
  168.      A number of changes will be visible as soon as the screen opens - a non-
  169.    laced screen, two new gadgets in the header which will show page rather than
  170.    line numbers.  The colour gadget will not work, nor will scrolling.  Since
  171.    pictures and animations must appear complete  - not split between pages -
  172.    the display has to be based on showing complete whole pages, and colors must
  173.    appear as the artist intended.
  174.  
  175.      The two new header gadgets are labelled:
  176.  
  177.      NOP.    No pictures.  Only the text will appear and no illustrations.  The
  178.    display adopts the non-illustrated mode of operation.
  179.  
  180.      NOC.    No cycling.  Cycling cannot be activated.
  181.  
  182.      Once illustrations have been inhibited by toggling NOP the necessity for
  183.    stopping the operation of scrolling and color changes disappears, the mode
  184.    of operation changes to that used for normal texts, scrolling and the color
  185.    gadget are enabled, and the header shows line rather than page numbers when
  186.    The position in the file has been changed.
  187.  
  188.      If NOP is clicked again the display will revert to the illustrated mode.
  189.  
  190.      The function keys will work as before, however calls to print the page or
  191.    file using F6/7 will print only the text.  To dump a picture to the printer
  192.    set the cursor over the picture and double-click the RIGHT mouse button.  A
  193.    requester will come up asking for confirmation before the picture is dumped.
  194.    Any new file called by F9 must be of the same type, that is another 
  195.    illustrated file.
  196.  
  197.  PREPARATION OF ILLUSTRATED TEXT FILES 
  198.  
  199.      The preparation of illustrated texts for P-Reader is much easier with 
  200.    P-Writer, its partner in the P-Suite stable.  However P-Writer is not
  201.    essential.
  202.  
  203.  Colour and Style Changes
  204.    The normal escape codes are used.    The most useful being:
  205.    reset   ^[[0;31;40m     b'ground Pen1  ^[[41m     style bold    ^[[1m 
  206.    text Pen1   ^[[31m      b'ground Pen2  ^[[42m     style italic  ^[[3m 
  207.    text Pen2   ^[[32m      b'ground Pen3  ^[[43m     underline     ^[[4m
  208.    text Pen3   ^[[33m
  209.  
  210.    The initial ^[ represents the insert introducer or CSI, the non-printing
  211.    character produced by 'Esc'.  Refer to the instructions for your text
  212.    editor to see how to insert this.
  213.  
  214.  Three types of graphics (four if you count sounds) can be called :
  215.  
  216.  ILBMs (IFF pictures) 
  217.                        
  218.    True ILBMs produced by DPaint or any of the standard drawing software can
  219.    be used, provided that:
  220.  
  221.      Size is no greater than 640 X 256 (PAL) or 640 X 200 (NTSC).
  222.      No HAM or HALFBRITE.
  223.      Depth is three planes (eight colours).
  224.  
  225.    The picture shares a screen with the text, so the palette used by the
  226.    picture will affect screen colours.  Wherever possible the first four 
  227.    colours of the picture should be close to 000, FFA, 3F3, F20.  The rest of
  228.    the default palette is 45F, FC8, A60, 0A0.
  229.  
  230.       Calling syntax:  (do not leave any space between # and !) :
  231.  
  232.        # !  1 [Left edge] [Top edge] [Cycling] [File] 
  233.                                       (Cycling: ON = 1,  OFF = 0)
  234.  
  235.    The sequence may be placed anywhere on the page, but is best put at the
  236.    bottom so that all text is displayed first.  Any text after # followed by !
  237.    is not displayed. (Which is why "# followed by !" has to be written here).
  238.  
  239. ANIMATIONS                                     
  240.                                                     
  241.    This version supports straightforward ANIM5 animations as produced by
  242.  DPaint, Videoscape, The Projector, P_Animator and others.  Full information on
  243.  how to create animations for P-Reader are given in P_Animator.  The animation 
  244.  must be HIRES, 3 planes, 640*256 for a PAL text, 640*200 for NTSC.
  245.  
  246.    The command syntax is:  # ! 2 0 0 0 [File]           
  247.                                
  248.    The sequence can go anywhere on the page.  There should be no text directly 
  249.  under the anim.
  250.  
  251.   UP TO THREE ILBMs OR ONE ANIM MAY BE CALLED ON EACH PAGE
  252.  
  253.  SOUNDS
  254.  
  255.    Sound effects can be included if they are in the normal 8SVX format.        
  256.    Command syntax:  # ! 4 [File]
  257.  
  258.  BORDERS
  259.  
  260.    Provides a standard Intuition Border which may be used to enclose text or 
  261.   pictures.  
  263.    Command syntax is:  # ! 3 [Left edge] [Top line] [Width] [Height] [Pen]
  264.  
  265.    The command sequence may be placed anywhere on the page, however to prevent 
  266.   the border from being over-written by text it is best put on a line below
  267.   where the border will appear. 
  268.    
  269.  
  270.   SUMMARY OF KEY-COMMANDS   (Pressing HELP key displays this)
  271.     F1 <page> or <line> <return>       Move to <page> or <line> 
  272.     F2/F3                              Move to first/final page
  273.     F4/F5                              Search/search again
  274.     F6/F7                              Print Page/File
  275.     F8                                 Move screen to back
  276.     F9                                 Get next file
  277.     F10                                Save file ASCII
  278.  
  279.     Inset graphics           Stop Cycling        Press any key
  280.                              Print               Click RMB twice
  281.   
  282.     ILBM reader              Start/stop cycling  Press <TAB>/any key
  283.                              Print               Click RMB twice
  284.  
  285.     Animation                Start               Click LBM
  286.                              Stop                Click again 
  287.  
  288.     Scroll up/down           RMB/LMB   <SHIFT> toggles speed
  289.  
  290.                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  291.  
  292.    P-Reader may be freely copied and circulated in whole or in part, provided 
  293.   that any distribution is accompanied by this file.   The programme may be
  294.   used for any non-commercial or non-profit-making purpose.  Authority for
  295.   commercial or profit-making purposes may be obtained from the author -
  296.   proposals for payment in kind will be looked on favorably. 
  297.  
  298.   Reactions, suggestions, bug-reports all welcome.
  299.  
  300.   A.M.H Wyndham
  301.   1265 Canning Mills Road,
  302.   Roleystone,
  303.   WA 6111
  304.   Australia
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.