//====//====//       “Using”         //====//====//====//====//====//====//

Contents:
	New
	Loading
	Saving
	Quitting
	Locking
	Cursors
	Keyboard Shortcuts
	Mouse
	StatusBar
	Syntax Styling
	View Modes
	Shell Mode
	Undo
	Misc

New:
	The keypad now has cool fuctionality!
	The grey "+" doubles as "Paste".
	The grey "-" cuts the line under the cursor
		and places it on the Clipboard.
	The grey "/" Copies the line under the cursor.

Loading:
	You can load a document by:
		• Dragging a file onto a Yate Window.
		• Dragging a file onto the Yate Icon.
		• Double Clicking a file of type YateText.
		• Typing “yate myfile.txt &” from BASH.
		• Choosing “Open” from the “Editor” Menu.
		• Using 'Open Suffix'
		• Using 'Open Selection' (e.g. #include "Mine.h" )
		• Using 'Next Error'

	(∆) Yate now treats all files as Binary.
	Very large files may take some time to load, so
	please be patient.
	Your other windows may still work during this time.

	(••) The complete works of Shakespeare' ~5Mo takes
	about 90s to load on my 2x133 BeBox
	(†††) Try loading two copies of the same Document.

Saving:
	(∆) Yate now treats all files as Binary.
	That is, what you see in the Hex-Viewer is exactly
	what is placed on disk.

	(••)I've made some attempts to warn the user
	if there was an error during saving, and recently
	added a BFilePanel for saving.  These are ALPHA
	features: use at your own risk :-)
	(†††)Yate doesn't “safe-save” or make backups (yet).

Quitting:
	Closing all the open windows causes Yate to Quit.
	You can also use Alt-Q to Quit.
	Be wary of the ‘unsaved files’ dialog when quitting
		-It has not been fully tested.

Locking Protocol:
	Where Yate displays a filename it is typically
	prefixed with a glyph to show that documents'
	status.

	The Glyph will be one of   - + ! ? > $

	- Means that this is a normal document

	+ Means changes have occured to this
		Document.  It probably needs saving

	! Means that this file does not yet have
		a filename, or that it's filename is
		invalid.  An attempt to save this
		file should bring up a Save FilePanel

	? Means that two or more documents
		are loaded which have the same filename.
		(This is a rare occurence.)

	> Means that this is a ‘Shell-Mode’ Document

	$ is similar to + but for ‘Shell-Mode’

	More glyphs may be added in future.
	In particular; NodeWatchers may be added
	and ‘manifest’ style documents may have
	their own identifying Glyph.


Cursors:
	Yate cursors may be somewhat confusing at first.
	Lets start with some definitions.
	Each cursor consists of two parts:
		The “Carat” is the (blinking) vertical line.
		The “Block” is the currently selected text.

	In Yate, you can move the Carat even when
	a Block is selected.  It takes a little bit of
	getting used to - but I find it quite useful.
	In particular, you can't accidently delete
	a large block of text with careless typing
	(something I do quite often in other editors)

	But it gets stranger still..

	Each Document has a black, a red, a green
	and a blue cursor.  yes - each Document
	may have up to 4 different Carats.  Previous
	Yate's allowed up to 4 different Blocks.
	However' Yate95 allows only one Block per
	Document.

	You can choose which colour of cursor to
	use in the Window menu.  The Window
	will then use that same cursor on every
	document it edits.

	The idea is that two different windows can
	display the same document, yet edit it in
	different locations.  See "Yak.txt" for one
	possible use of this behaviour.

	The 'Colour' of the cursor refers to the way
	previous versions of Yate allowed each cursor
	it's own block that then had this colour.  While
	easy to do for the Text, it provides technical
	difficulties for the Renderer and has been left
	out of this version.

Keyboard ShortCuts:

	Left/Right:Move left/right one character.
	Up/Down: Move up/down one line.
	Home: Beginning of current line / First character.
	End: End of current line / Last ASCII character.
	Page Up/Page Down:Move Up/Down a page.
	Insert: NOTHING (YAYAYAYYAY :-)
	Scroll-Lock:NOTHING
	Backspace:Erase Left
	Delete:Erase Right.
	CTRL-Left/Right: Same as Home/End
	CTRL-Up/Down: Up/Down 50000 lines.
	CTRL-TAB: Switch to next window.

	F1: Position start of block.
	F2: Position end of block.
	F3: Find-Forward
	F4: Next Error
	Shift-F3: Find-Backward

	CTRL-R: Find Backward
	CTRL-S: Find Forward
	CTRL-,: Next Window  (comma)

	KeyPad with Numlock disabled:
		Grey +:  Paste.
		Grey -: Cut line beneath cursor.
		Grey *: Copy line beneath cursor.

	In the “Doc List” Menu:
		“Previous Document” is ALT ‘-’ (alt-minus)
		“Next Document” is ALT ‘=’ (alt-equals, or alt-unshift-plus)

	(†††) See “Programmers” for changing key bindings

The Mouse:
	Hmm. the mouse is really boring in this release…
	It should get back some of it's old funk in the
	future tho…

	(••) double/triple clicks are missing from Yate95.
	My deepest apologies to all those mousers out there.

StatusBar:
	Across the bottom of the window we have:
		• Horizontal Position
		• Line Number
		• Find String
		• Replace String
	And beneath them, the (optional) Message Display.

	You can use the following keys:
		• Enter:  Attempt to execute function.
		• Shift-Tab:    Move to Previous field.
		• Tab:    Move to Next field.
		• Esc:    Escape Back to Editor.

	(••)Find is Forwards, case-insensitive and ‘wraps’.
	(†††) Figure out how to use Replace


Syntax Styling:
	This still needs some work… URL highlighing,
	EMail mode and multi-line comments.
	HTML highlighting is in and was good practise for
	the up-coming HTML Viewer.

	(••) Be sure to check out “tokens.txt” in the
	yate.res Folder.   e.g:
	if this public register signed,  switch TRUE friend .
	overload:  break auto-operator switch …

	See also “Programmers.txt”


(∆)View Modes:
	New in this release, this allows you to view the
	same document in different ways - in particular,
	as Hex, Text or HTML.
	Expect much more work here in the future.
	Things like naked ASCII, Hex-Entry widgets, a
	much  better looking Hex Viewer and of course,
	at least a HTML1.1 Viewer.

Shell Mode:
	This mode lets you execute shell commands
	directly from Yate, without the need to switch
	applications.  You can toggle this option from the
	“Document” menu.

	A line prefaced with ‘$’ is executed just as if
	you typed it from Bash.

	The “Make” item in the “Editor” menu  attempts to
	execute the command “Make” in the first available
	‘Shell-Mode’ document.

	Yate can interpret the error messages generated
	by mwcc or gcc. Press F4 to cycle through the
	errors.  I typically have the error window open
	on the left of my screen with my editing windows
	open on the right.  Note that the data is 'live' you
	can be fixing errors while the compiler is still compiling.

	For best results in this release, launch Yate
	from Terminal to set the Working Directory.

	(†††) Try Shelling “$ Yate /boot/myfile.txt &”
	(†††) Try crashing Shell Mode (whoooo… hard :-)

Undo:
	This uses the one-key undo approach.
	That is, your undos are treated just as if
	you typed/deleted the text and will be undone
	exactly the same way.
	This approach means you have the entire
	history available if you hold down Alt-Z enough
	times.

	This still has a few bugs - particularly the
	'+' flag to denote the file hasn't changed still
	needs some work.
	I Also intend to do both word based and
	operation based undos - so don't freak out
	just yet..
	Undo is a global operation - supporting multi
	players could be a real nightmare.. consider
	what happens if Player 2 deletes something
	Player 1 types - then Player 1 presses "undo"..



Misc:
	• Try opening Windows in different resolutions.
	• Yate will run in the color_space of it's parent.
	• Have fun with the Font Size Sub-Menu.

//====//====//====//====//====//====//====//====//====//====//

Be Brave,
Chris Blackbourn
blakatz@ihug.co.nz
http://www.geocities.com/TimesSquare/Arcade/1783
