home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 3: The Continuation / 17-Bit_The_Continuation_Disc.iso / files / 2556.dms / 2556.adf / c / FullView.doc / FullView.doc
Text File  |  1993-04-01  |  11KB  |  280 lines
  1.  
  2.                     --------------------------------------
  3.                     -           FullView v3.04           -
  4.                     -                                    -
  5.                     - (c) Copyright 1991 Jonathan Potter -
  6.                     --------------------------------------
  7.  
  8.                 -- See the bottom of this file for changes --
  9.  
  10.     FullView is a text viewer that offers fast, smooth-scrolling ANSI
  11. compatible text displays.
  12.  
  13.     FullView opens up to the full size of the Workbench screen
  14. (non-interlaced). Because there is no slider gadget at the side of the screen,
  15. you are able to view full 80 column text with a standard Workbench
  16. configuration (many text viewers only show 78 columns across).
  17.  
  18.     To start FullView from the CLI, simple type
  19.  
  20.         FullView filename
  21.  
  22.     or from the Workbench, double-click on a project icon that has FullView
  23. as its default tool.
  24.  
  25.     FullView will load text and pictures that have been crunched with
  26. PowerPacker, by Nico Francois.
  27.  
  28.     FullView has a built-in help screen that can instantly explain its
  29. functions, as well as remind you of the keyboard equivalent of many commands.
  30. However, here are brief instructions on the operation of the commands. They are
  31. listed with the command name (if this command is accessed from a menu, this is
  32. also the name of the menu item), and any keyboard equivalents the command may
  33. have.
  34.  
  35.         Load...        AMIGA-L or l key
  36.  
  37.         This command allows you to load a new text file using the
  38. built-in file requester. The file requester is similar to the Commodore ASL
  39. requester and to the ARP file requester, and thus most users should be familiar
  40. with its operation.
  41.  
  42.         Show Pic...    AMIGA-H or h key
  43.  
  44.         This command allows you to display an IFF ILBM picture file. A
  45. wide variety of formats is supported, including HAM, Overscan, EHB and
  46. Dynamic-HiRes.
  47.  
  48.         Save As...    AMIGA-V or v key
  49.  
  50.         This command allows you to save the currently displayed text
  51. file under a new name. This can also be useful for converting
  52. PowerPacker-crunched text into plain ASCII text.
  53.  
  54.         Print all    AMIGA-P or p key
  55.  
  56.         This command will print the current text file to the printer
  57. (PRT:).
  58.  
  59.         Print screen    AMIGA-C or c key
  60.  
  61.         This command will print the currently displayed page of text to
  62. the printer (PRT:).
  63.  
  64.         Search for...    AMIGA-S or s key
  65.  
  66.         This command allows you to search the current text file for a
  67. text string. Wildcard characters are not supported. The search takes place from
  68. the top of the currently displayed page.
  69.  
  70.         Repeat search    AMIGA-R or r key
  71.  
  72.         This command repeats the last text search, from the current
  73. position in the file.
  74.  
  75.         About
  76.  
  77.         This function displays some information about the program,
  78. including version number and how to contact the author.
  79.  
  80.         Help        HELP key
  81.  
  82.         This function displays a brief list of commands and their
  83. keyboard equivalents.
  84.  
  85.         Iconify        AMIGA-I or i key
  86.  
  87.         This command closes the FullView screen and opens a small
  88. window on the Workbench screen. This allows you to keep your text file in
  89. memory and refer to it at any time, but saves on memory when it is not actually
  90. being accessed. To return to the text file, click where the iconified window
  91. tells you to. Clicking the close gadget will remove the text file from memory
  92. without returning.
  93.  
  94.         Quit        AMIGA-Q or q, x, or ESCape key
  95.  
  96.         This command will remove FullView from memory.
  97.  
  98.         Auto scroll    SPACE bar or left mouse button
  99.  
  100.         FullView will auto-scroll text at four different speeds. The
  101. speed is determined by the vertical position of the mouse; the center of the
  102. screen is "neutral", and the further away from the center you move the mouse,
  103. the faster FullView will scroll in that direction.
  104.  
  105.         To toggle auto-scrolling, either press the SPACE bar or press
  106. the left mouse button. The mouse pointer will disappear while FullView is
  107. auto-scrolling, and reappear when scrolling stops (when you either stop it
  108. manually or the text reaches the top or bottom).
  109.  
  110.         Line up        Cursor up key or /\ gadget
  111.  
  112.         This function scrolls one line up through the text. If you
  113. continue to hold down the key or the gadget, this function will repeat after a
  114. brief interval.
  115.  
  116.         Line down    Cursor down key or \/ gadget
  117.  
  118.         This function scrolls one line down through the text. If you
  119. continue to hold down the key or the gadget, this function will repeat after a
  120. brief interval.
  121.  
  122.         Page up        Shift + Cursor up key, u key or U gadget
  123.  
  124.         This function moves one full page up through the text.
  125.  
  126.         Page down    Shift + Cursor down key, d key or D gadget
  127.  
  128.         This function moves one full page down through the text.
  129.  
  130.         Top of text    Control + Cursor up key, t key or T gadget
  131.  
  132.         This function moves to the beginning of the current text file.
  133.  
  134.         Bottom of text    Control + Cursor down key, b key or B gadget
  135.  
  136.         This function moves to the end of the current text file.
  137.  
  138.         Jump to line    j key or line gadget
  139.  
  140.         This function allows you to jump to a specified line number.
  141. The line gadget is the number that displays the current line being viewed in
  142. the status bar at the bottom of the screen (xxxxx > yyyyy; it is the xxxxx
  143. value)
  144.  
  145.         Jump to percent    J key or percent gadget
  146.  
  147.         This function allows you to jump a specified percentage into
  148. the file. This percent gadget is the number that displays the current
  149. percentage of text being viewed in the status bar (xxx%)
  150.  
  151.  
  152.     IFF routines
  153.  
  154.     FullView can show many different IFF ILBM formats, including HAM,
  155. Overscan, Extra Half Brite, and Dynamic-HiRes. There are four main ways to show
  156. an IFF picture with FullView.
  157.  
  158.         a) Run FullView with no arguments, and select an IFF picture
  159. with
  160.            the file requester.
  161.  
  162.         b) Once FullView has loaded a text file, select the Show Pic...
  163.            command and select an IFF picture with the file requester.
  164.  
  165.         c) Run FullView from the CLI with the name of an IFF picture
  166. and
  167.            use the +p argument.
  168.  
  169.            The +p tells FullView that it is a picture you want to show,
  170.            not a text file to read. The +p goes on the command line,
  171. after
  172.            the filename. For example,
  173.  
  174.                FullView dh0:Picture.iff +p
  175.  
  176.         d) From the Workbench, specify FullView as the default tool of
  177. a
  178.            picture file, and add the ToolType :
  179.  
  180.                FILETYPE=ILBM
  181.  
  182.            This has the same effect as the +p argument from the CLI.
  183.  
  184.     When a picture is displayed, there are several key presses that do
  185. different things. You can turn the mouse pointer on or off with the . key. You
  186. can stop/start colour cycling (if the file has colour cycling information) with
  187. the TAB key. Pressing the p key will print the picture. If a picture is larger
  188. than the screen, you can scroll around it using the cursor keys; by themselves
  189. they move in single steps, in conjunction with Shift they move a page, and in
  190. conjunction with Control they move to the start (or end). To return from a
  191. displayed picture, press the left mouse button, or the q or ESCape key.
  192.  
  193.  
  194.     TAB size
  195.  
  196.     The default size of tab characters in FullView is 4 spaces. You may, if
  197. running from the Workbench, specify the tab size yourself. To do this, add the
  198. following ToolType to the project icon :
  199.  
  200.         TABSIZE=size
  201.  
  202.     size is the number of spaces a tab character is to be equivalent to,
  203. and may be any number from 1 to 10.
  204.  
  205.  
  206.     ANSI codes
  207.  
  208.     FullView supports the ANSI codes used to change colour and type style.
  209. Because of the way FullView displays its text, there is a limitation on the
  210. changing of colour and type style; the colour and style is reset at the start
  211. of every line. This should not cause any major problems, but it does mean that
  212. if you wanted a rectangle of colour, you would have to specify the ANSI codes
  213. for every line, instead of just at the start and end of the rectangle. An
  214. example of this is the rectangular header of this document file.
  215.  
  216.     For your information, the applicable ANSI codes are :
  217.  
  218.     0    reset                1    bold face
  219.     3    italic                4    underscore
  220.     7    inverse video
  221.  
  222.     30    foreground pen colour 0        40    background pen colour 0
  223.     31    foreground pen colour 1        41    background pen colour 1
  224.     32    foreground pen colour 2        42    background pen colour 2
  225.     33    foreground pen colour 3        43    background pen colour 3
  226.  
  227.     ANSI codes are included in text using an escape code. This code looks
  228. like :
  229.  
  230.         <CSI>code[;code[;code]]m
  231.  
  232.     CSI is the Control Sequence Introducer, and it consists of an ESCape
  233. character and a [ character. For instance, to set the foreground colour to pen
  234. colour 2, the background colour to pen colour 3, and the style to italics and
  235. underscore, the control sequence would be :
  236.  
  237.         [[32;43;3;4m
  238.  
  239.         And here it is!!!
  240.  
  241.     You do not need to specify the [[0m reset sequence at the end of every
  242. line, as colours and styles are reset automatically for each line.
  243.  
  244.  
  245.     Word wrapping
  246.  
  247.     FullView will wrap-around to the next line any words that do not fit on
  248. the current line. This should normally not cause a problem. It could, however,
  249. cause trouble if FullView wraps words that are supposed to be a different
  250. colour and style. As colours and styles are reset for each line, any words that
  251. were wrapped would not be in the desired colour/style. There is no easy way out
  252. of this; all you can do is preview your text to make sure that this has not
  253. occurred. If it has, or you perceive it likely to happen, you can specify the
  254. escape code for each individual word. For instance,
  255.  
  256.         [[1mEach [[1mIndividual [[1mWord
  257.  
  258.  
  259.     Speaking of wrapping...
  260.  
  261.     That about wraps it up for this document file. FullView is largely
  262. self-explanatory, and I hope that I have covered all of the necessary points in
  263. this text. If you ever have trouble with FullView, please contact me at the
  264. address below.
  265.  
  266.     FullView is copyright, but is freely distributable. If you wish to use
  267. it in a commercial venture, however, you must contact me.
  268.  
  269.  
  270.                                Jonathan Potter
  271.                                  P.O. Box 289
  272.                               Goodwood, SA 5034
  273.                                   Australia
  274.  
  275.                              Phone : (08) 2932788
  276.                               Fax : (08) 2938941
  277.  
  278.                              FidoNET : 3:680/829
  279.                     Internet : jpotter@itd.adelaide.edu.au
  280.