Docs/FULLVIEW.DOC — Disk 159 — Assassins Games

ASCII text, with very long lines (681), with escape sequences — 5K bytes — 1992-09-02 — PP20 compressed
                    [32;41m--------------------------------------
                    [32;41m-           FullView v3.04           -
                    [32;41m-                                    -
                    [32;41m- (c) Copyright 1991 Jonathan Potter -
                    [32;41m--------------------------------------

                [33m-- See the bottom of this file for changes --

	[1mFullView[0m is a text viewer that offers fast, smooth-scrolling ANSI compatible text displays.

	[1mFullView[0m opens up to the full size of the Workbench screen (non-interlaced). Because there is no slider gadget at the side of the screen, you are able to view full 80 column text with a standard Workbench configuration (many text viewers only show 78 columns across).

	To start [1mFullView[0m from the CLI, simple type

		[33mFullView filename

	or from the Workbench, double-click on a project icon that has [1mFullView[0m as its default tool.

	[1mFullView[0m will load text and pictures that have been crunched with [32mPowerPacker[0m, by [1mNico Francois[0m.

	[1mFullView[0m has a built-in help screen that can instantly explain its functions, as well as remind you of the keyboard equivalent of many commands. However, here are brief instructions on the operation of the commands. They are listed with the command name (if this command is accessed from a menu, this is also the name of the menu item), and any keyboard equivalents the command may have.

		[33mLoad...[0m		[1mAMIGA-L[0m or [1ml[0m key

		This command allows you to load a new text file using the built-in file requester. The file requester is similar to the Commodore ASL requester and to the ARP file requester, and thus most users should be familiar with its operation.

		[33mShow Pic...[0m	[1mAMIGA-H[0m or [1mh[0m key

		This command allows you to display an IFF ILBM picture file. A wide variety of formats is supported, including HAM, Overscan, EHB and Dynamic-HiRes.

		[33mSave As...[0m	[1mAMIGA-V[0m or [1mv[0m key

		This command allows you to save the currently displayed text file under a new name. This can also be useful for converting PowerPacker-crunched text into plain ASCII text.

		[33mPrint all[0m	[1mAMIGA-P[0m or [1mp[0m key

		This command will print the current text file to the printer (PRT:).

		[33mPrint screen[0m	[1mAMIGA-C[0m or [1mc[0m key

		This command will print the currently displayed page of text to the printer (PRT:).

		[33mSearch for...[0m	[1mAMIGA-S[0m or [1ms[0m key

		This command allows you to search the current text file for a text string. Wildcard characters are not supported. The search takes place from the top of the currently displayed page.

		[33mRepeat search[0m	[1mAMIGA-R[0m or [1mr[0m key

		This command repeats the last text search, from the current position in the file.

		[33mAbout[0m

		This function displays some information about the program, including version number and how to contact the author.

		[33mHelp[0m		[1mHELP[0m key

		This function displays a brief list of commands and their keyboard equivalents.

		[33mIconify[0m		[1mAMIGA-I[0m or [1mi[0m key

		This command closes the [1mFullView[0m screen and opens a small window on the Workbench screen. This allows you to keep your text file in memory and refer to it at any time, but saves on memory when it is not actually being accessed. To return to the text file, click where the iconified window tells you to. Clicking the close gadget will remove the text file from memory without returning.

		[33mQuit[0m		[1mAMIGA-Q[0m or [1mq[0m, [1mx[0m, or [1mESCape[0m key

		This command will remove [1mFullView[0m from memory.

		[33mAuto scroll[0m	[1mSPACE[0m bar or [1mleft mouse button[0m

		[1mFullView[0m will auto-scroll text at four different speeds. The speed is determined by the vertical position of the mouse; the center of the screen is "neutral", and the further away from the center you move the mouse, the faster [1mFullView[0m will scroll in that direction.

		To toggle auto-scrolling, either press the [1mSPACE[0m bar or press the [1mleft [1mmouse [1mbutton[0m. The mouse pointer will disappear while [1mFullView[0m is auto-scrolling, and reappear when scrolling stops (when you either stop it manually or the text reaches the top or bottom).

		[33mLine up[0m		[1mCursor up[0m key or [1m/\[0m gadget

		This function scrolls one line up through the text. If you continue to hold down the key or the gadget, this function will repeat after a brief interval.

		[33mLine down[0m	[1mCursor down[0m key or [1m\/[0m gadget

		This function scrolls one line down through the text. If you continue to hold down the key or the gadget, this function will repeat after a brief interval.

		[33mPage up[0m		[1mShift[0m + [1mCursor up[0m key, [1mu[0m key or [1mU[0m gadget

		This function moves one full page up through the text.

		[33mPage down[0m	[1mShift[0m + [1mCursor down[0m key, [1md[0m key or [1mD[0m gadget

		This function moves one full page down through the text.

		[33mTop of text[0m	[1mControl[0m + [1mCursor up[0m key, [1mt[0m key or [1mT[0m gadget

		This function moves to the beginning of the current text file.

		[33mBottom of text[0m	[1mControl[0m + [1mCursor down[0m key, [1mb[0m key or [1mB[0m gadget

		This function moves to the end of the current text file.

		[33mJump to line[0m	[1mj[0m key or [1mline gadget[0m

		This function allows you to jump to a specified line number. The [1mline gadget[0m is the number that displays the current line being viewed in the status bar at the bottom of the screen (xxxxx > yyyyy; it is the xxxxx value)

		[33mJump to percent[0m	[1mJ[0m key or [1mpercent gadget[0m

		This function allows you to jump a specified percentage into the file. This [1mpercent gadget[0m is the number that displays the current percentage of text being viewed in the status bar (xxx%)


	[32mIFF routines

	[1mFullView[0m can show many different IFF ILBM formats, including HAM, Overscan, Extra Half Brite, and Dynamic-HiRes. There are four main ways to show an IFF picture with FullView.

		a) Run [1mFullView[0m with no arguments, and select an IFF picture with
		   the file requester.

		b) Once [1mFullView[0m has loaded a text file, select the [33mShow Pic...
		   command and select an IFF picture with the file requester.

		c) Run [1mFullView[0m from the CLI with the name of an IFF picture and
		   use the [1m+p[0m argument.

		   The [1m+p[0m tells [1mFullView[0m that it is a picture you want to show,
		   not a text file to read. The [1m+p[0m goes on the command line, after
		   the filename. For example,

		       [33mFullView dh0:Picture.iff +p

		d) From the Workbench, specify [1mFullView[0m as the default tool of a
		   picture file, and add the ToolType :

		       [33mFILETYPE=ILBM

		   This has the same effect as the [1m+p[0m argument from the CLI.

	When a picture is displayed, there are several key presses that do different things. You can turn the mouse pointer on or off with the [1m.[0m key. You can stop/start colour cycling (if the file has colour cycling information) with the [1mTAB[0m key. Pressing the [1mp[0m key will print the picture. If a picture is larger than the screen, you can scroll around it using the [1mcursor[0m keys; by themselves they move in single steps, in conjunction with [1mShift[0m they move a page, and in conjunction with [1mControl[0m they move to the start (or end). To return from a displayed picture, press the [1mleft mouse button[0m, or the [1mq[0m or [1mESCape[0m key.


	[32mTAB size

	The default size of tab characters in [1mFullView[0m is 4 spaces. You may, if running from the Workbench, specify the tab size yourself. To do this, add the following ToolType to the project icon :

		[33mTABSIZE=size

	[1msize[0m is the number of spaces a tab character is to be equivalent to, and may be any number from 1 to 10.


	[32mANSI codes

	[1mFullView[0m supports the ANSI codes used to change colour and type style. Because of the way [1mFullView[0m displays its text, there is a limitation on the changing of colour and type style; the colour and style is reset at the start of every line. This should not cause any major problems, but it does mean that if you wanted a rectangle of colour, you would have to specify the ANSI codes for every line, instead of just at the start and end of the rectangle. An example of this is the rectangular header of this document file.

	For your information, the applicable ANSI codes are :

	0	reset				1	[1mbold face[0m
	3	[3mitalic[0m				4	[4munderscore[0m
	7	[7minverse video[0m

	30	[30;41mforeground pen colour 0[0m		40	background pen colour 0
	31	foreground pen colour 1		41	[30;41mbackground pen colour 1
	32	[32mforeground pen colour 2[0m		42	[42mbackground pen colour 2
	33	[33mforeground pen colour 3[0m		43	[43mbackground pen colour 3

	ANSI codes are included in text using an [1mescape code[0m. This code looks like :

		[33m<CSI>code[;code[;code]]m

	[1mCSI[0m is the [1mControl Sequence Introducer[0m, and it consists of an [1mESCape[0m character and a [1m[[0m character. For instance, to set the foreground colour to pen colour 2, the background colour to pen colour 3, and the style to italics and underscore, the control sequence would be :

		[7m[[0m[32;43;3;4m

		[32;43;3;4mAnd here it is!!!

	You do not need to specify the [7m[[0m[0m reset sequence at the end of every line, as colours and styles are reset automatically for each line.


	[32mWord wrapping

	[1mFullView[0m will wrap-around to the next line any words that do not fit on the current line. This should normally not cause a problem. It could, however, cause trouble if [1mFullView[0m wraps words that are supposed to be a different colour and style. As colours and styles are reset for each line, any words that were wrapped would not be in the desired colour/style. There is no easy way out of this; all you can do is preview your text to make sure that this has not occurred. If it has, or you perceive it likely to happen, you can specify the escape code for each individual word. For instance,

		[7m[[0m[1mEach [7m[[0m[1mIndividual [7m[[0m[1mWord


	[32mSpeaking of wrapping...

	That about wraps it up for this document file. [1mFullView[0m is largely self-explanatory, and I hope that I have covered all of the necessary points in this text. If you ever have trouble with [1mFullView[0m, please contact me at the address below.

	[1mFullView[0m is copyright, but is freely distributable. If you wish to use it in a commercial venture, however, you must contact me.


                               [33mJonathan Potter
                                 [33mP.O. Box 289
                              [33mGoodwood, SA 5034
                                  [33mAustralia

                             [33mPhone : (08) 2932788
                              [33mFax : (08) 2938941

                             [33mFidoNET : 3:680/829
                    [33mInternet : jpotter@itd.adelaide.edu.au