@database TextEngine
@author "Nicholas Harvey"
@(c) "1995 Nicholas Harvey"

## $VER: TextEngine AmigaGuide documentation V1.0

@node "Main" "TextEngine V5.0 documentation"
                               @{b}TextEngine V5.0@{ub}
                    Copyright © Nicholas Harvey 1991-95.
           @{i}"A user friendly solution to your word processing needs" @{ui}

      @{"Introduction        " link Introduction}    Welcome to TextEngine!
      @{"Shareware           " link Shareware}    How much does TextEngine cost?
      @{"Features            " link Features}    What can TextEngine do?
      @{"Requirements        " link Requirements}    What is needed to run TextEngine?
      @{"Installation        " link Installation}    On either hard or floppy disks.

      @{"Loading TextEngine  " link LoadingTextEngine}    Loading from Workbench or CLI.
      @{"User settings       " link UserSettings}    Setting up TextEngine.

      @{"Program menus       " link ProgramMenus}    A quick guide to TextEngine's menus.
      @{"Editing text        " link EditingText}    Text editing tools and features.
      @{"Handling files      " link HandlingFiles}    Loading and saving your documents.
      @{"The spelling checker" link SpellingChecker}    Correcting typing and spelling mistakes.

      @{"Thanks to...        " link ThanksTo}    Friends and supporters.
@endnode

@node Introduction "Introduction"
@{b}@{u}Introduction@{ub}@{uu}
Welcome to TextEngine V5.0, a shareware word processing system for the 
Amiga written in 100% assembly language.

TextEngine is a raw text processor allowing text to be entered, formatted, 
and then printed using standard built-in printer fonts. It has been designed
with simplicity and speed in mind but still boasts a number of powerful 
@{"features" link Features} making it ideal for editing reports, E-Mail, and programs alike.

I have tried my best to make the program as easy to use as possible so that 
you can simply go ahead and use it without making constant references to the
instructions. However, it is worth reading this entire document through at 
least once (even if you have upgraded from an older version) so that you 
are aware of the subtler features which are contained within the program.
@endnode

@node Shareware "Shareware registration"
@{b}@{u}Shareware registration@{ub}@{uu}
I have released TextEngine as a freely distributable shareware product, and 
it is @{u}not@{uu} public domain. However, unlike some shareware offerings, this is 
the FULL program, not restricted or crippled in any way whatsoever. I feel 
that I would much rather people use and enjoy my program for free than for 
them to not use it at all.

So what reasons are there for you to register then? Well, along with 
receiving a personal reply from myself (guaranteed), you will also receive a
free upgrade (if and when one appears), plus free advice on TextEngine 
related problems. Basically though, the bottom line is that I have given you
a complete working program, and you have three options:

1. Format/trash/burn the floppy disk.
2. Use TextEngine for free.
3. Use TextEngine, and show your appreciation by becoming a registered user.

So, if you'd like to become a registered user, here's what to do. Simply 
send £5 to me at the following address:

        Nicholas Harvey,
        Hawthorns,
        Sheringham Road,
        West Beckham, Holt,
        Norfolk. NR25 6PF
        United Kingdom

I can also be reached by E-mail for comments and bug reports at the 
following address:

        N.J.Harvey-93@student.lut.ac.uk
@endnode

@node Features "TextEngine V5.0 features"
@{b}@{u}TextEngine V5.0 features@{ub}@{uu}
Since its last release (version 4.1), TextEngine has undergone a total 
rewrite. Although no major new additions have been made, every feature of 
TextEngine has been improved to increase useability and flexibility. Here 
then are some of the more significant features of this new version:

- The GUI has been brought bang up to date by replacing the old fixed font 
  Intuition GUI with a fully font sensitive GadTools system. Since 
  TextEngine now uses the Workbench screen instead of its own custom one, 
  it adapts itself to your font, screen mode, and palette settings, 
  blending in seamlessly with your working environment.

- The length of a document is limited only by the amount of memory your 
  machine contains, the same applying to the cut & paste buffers.

- 11 type styles are still available, but now they are represented within 
  the document by more meaningful symbols (e.g. bold text is represented by 
  an inverted B character). Also, page margins are now overlaid on the text 
  editing window allowing for easier positioning of text on the page.

- BOOPSI slider gadgets in the window borders allow quick and easy movement 
  around long documents.

- TextEngine now supports the Workbench AppWindow feature, allowing 
  documents to be loaded by simply dragging their icons onto TextEngine's 
  window.

- The 36,000 word spelling checker has been made more intelligent and now 
  gives meaningful suggestions for the correct spelling of a word. Also, 
  words can now be corrected automatically by the spelling checker instead 
  of having to type corrections in by hand.
@endnode

@node Requirements "TextEngine V5.0 system requirements"
@{b}@{u}TextEngine V5.0 system requirements@{ub}@{uu}
I have programmed and tested TextEngine on my 4MB A1200 and it appears to 
work fine. However, no Workbench 3.x specific routines have been used, so 
it should be happy running on a 1MB system with Workbench 2.x. However, more
memory is recommended if the spelling checker is to be used whilst editing 
long documents.

TextEngine also requires the asl.library to be present in the LIBS drawer on
your boot disk, and the parallel.device and printer.device correctly 
installed in the DEVS drawer for printing documents.
@endnode

@node Installation "Installing TextEngine V5.0"
@{b}@{u}Installing TextEngine V5.0@{ub}@{uu}
All of TextEngine's files are contained within its own drawer, and it 
requires no assigns to be made.

To install TextEngine onto either a floppy disk or a hard drive, simply 
create a drawer called TextEngine (or any other name you choose), and copy 
the following files into it:

     TextEngine              - The program itself.
     TextEngine.info         - The program icon.
     TextEngine.guide        - This AmigaGuide documentation (optional).
     TextEngine.guide.info   - The documentation icon (optional).
     TextEngine5.0.dct       - The spell checker dictionary.
     TextEngine5.0.cfg       - The configuration file (optional).

If the .cfg file is not present then TextEngine will use the default 
preferences.

Once installation is complete, it is important to ensure that your boot disk
contains the necessary system libraries and devices else TextEngine will not
work correctly (see @{"Requirements" link Requirements} section for more details).
@endnode

@node LoadingTextEngine "Loading TextEngine"
@{b}@{u}Loading TextEngine@{ub}@{uu}
TextEngine can be loaded from either the CLI or Workbench.

@{b}@{u}Loading TextEngine from the CLI@{ub}@{uu}
1. Open a CLI window.

2. Type cd <name of drawer TextEngine is stored in>

   e.g. cd dh1:Business/TextEngine

3. Type TextEngine <filename>
   where <filename> is the optional filename of a file to be loaded 
   automatically when TextEngine starts up.

   e.g. TextEngine s:startup-sequence

@{b}@{u}Loading TextEngine from the Workbench@{ub}@{uu}
There are three ways TextEngine can be loaded from the Workbench.

1. Simply double click on its icon.

2. Click once on TextEngine's icon, and whilst holding down a shift key, 
   double click on a project icon. The project will then be loaded 
   automatically when TextEngine starts up.

3. Set TextEngine as a project's Default Tool (by using the Workbench icon 
   information editor). When the project's icon is then double clicked on, 
   TextEngine will be run and the project automatically loaded into it.
@endnode

@node UserSettings "Setting up TextEngine"
@{b}@{u}Setting up TextEngine@{ub}@{uu}
When TextEngine has been loaded up for the first time, or for some reason 
your TextEngine5.0.cfg file has been deleted, then the default settings will
be used. These settings can be customised by choosing options from the 
Settings menu, and the following areas are covered:

Word wrap           - This can be toggled by selecting the @{"Word Wrap" link MenuWordWrap} menu 
                      option.
Printer borders     - These can be toggled by selecting the @{"Show Borders" link MenuShowBorders}
                      menu option.
Printer setup       - This can be adjusted by selecting the @{"Printer" link MenuPrinter} menu 
                      option.
Function key macros - These can be set by selecting the @{"Function Keys" link MenuFunctionKeys} menu 
                      option.
Edit window colours - These can be chosen by selecting the @{"Colours" link MenuColours} menu 
                      option.

When you have finished adjusting TextEngine's settings, a configuration file
can be saved by selecting the @{"Save Settings" link MenuSaveSettings} menu option. Once this has been 
done, every time TextEngine is loaded it will be configured with your 
chosen settings.
@endnode

@node ProgramMenus "Program menus"
@{b}@{u}Program menus@{ub}@{uu}
Here are the menu options available in TextEngine.

        Project:        @{"New..." link MenuNew}
                        @{"Open..." link MenuOpen}
                        @{"Insert File..." link MenuInsertFile}
                        @{"Save" link MenuSave}
                        @{"Save As..." link MenuSaveAs}
                        @{"ASCII Save..." link MenuASCIISave}
                        Print »@{"Preview" link MenuPrintPreview}
                               @{"Document..." link MenuPrintDocument}
                        @{"About..." link MenuAbout}
                        @{"Quit..." link MenuQuit}

        Edit:           @{"Cut" link MenuCut}
                        @{"Copy" link MenuCopy}
                        @{"Paste" link MenuPaste}
                        @{"Find" link MenuFind}
                        @{"Find Again" link MenuFindAgain}
                        @{"Replace" link MenuReplace}

        Format:         @{"Bold" link MenuBold}
                        @{"Italic" link MenuItalic}
                        @{"Underline" link MenuUnderline}
                        @{"Condensed" link MenuCondensed}
                        @{"Double Strike" link MenuDoubleStrike}
                        @{"Elite" link MenuElite}
                        @{"Enlarged" link MenuEnlarged}
                        @{"Pica" link MenuPica}
                        @{"Subscript" link MenuSubscript}
                        @{"Superscript" link MenuSuperscript}
                        @{"Plain" link MenuPlain}

        Tools:          @{"Word Count..." link MenuWordCount}
                        @{"Top Of File" link MenuTopOfFile}
                        @{"End Of File" link MenuEndOfFile}
                        @{"Centre Line" link MenuCentreLine}

        Settings:       @{"Word Wrap" link MenuWordWrap}
                        @{"Show Borders" link MenuShowBorders}
                        @{"Printer..." link MenuPrinter}
                        @{"Function Keys..." link MenuFunctionKeys}
                        @{"Colours..." link MenuColours}
                        @{"Save Settings" link MenuSaveSettings}

        Spell:          @{"Open Dictionary" link MenuOpenDictionary}
                        @{"Close Dictionary" link MenuCloseDictionary}
                        @{"Update Dictionary" link MenuUpdateDictionary}
                        @{"Check Document..." link MenuCheckDocument}
@endnode

@node MenuNew "Menu option - New..."
@{b}@{u}Menu option - New...@{ub}@{uu}
Menu:           Project
Shortcut:       Right-Amiga + N
Purpose:        Clear current document and start a new one

Usage:
Selecting this option will open a requester querying your choice. Selecting 
OK will clear the current document, placing the cursor at the top of a blank
document. The operation can be cancelled by clicking on Cancel.
@endnode

@node MenuOpen "Menu option - Open..."
@{b}@{u}Menu option - Open...@{ub}@{uu}
Menu:           Project
Shortcut:       Right-Amiga + O
Purpose:        Open a document from disk

Usage:
Selecting this option will open a standard ASL load requester from which a 
file can be chosen. Selecting Open will clear the current document, 
replacing it with the chosen disk file. The operation can be aborted by 
clicking on Cancel.
@endnode

@node MenuInsertFile "Menu option - Insert File..."
@{b}@{u}Menu option - Insert File...@{ub}@{uu}
Menu:           Project
Shortcut:       None
Purpose:        Insert a file into the current document

Usage:
Selecting this option will open a standard ASL load requester from which a 
file can be chosen. Selecting Insert will insert the selected file into the 
current document at the cursor position.

With this new version of TextEngine, ASCII format files can now be inserted 
as well as @{"TextEngine format" link TextEngineFileFormat} files.
@endnode

@node MenuSave "Menu option - Save"
@{b}@{u}Menu option - Save@{ub}@{uu}
Menu:           Project
Shortcut:       Right-Amiga + S
Purpose:        Save the current document

Usage:
Selecting this option will immediately save the current document to disk 
under the filename it was loaded, or last saved, as. The document will be 
saved as a @{"TextEngine format" link TextEngineFileFormat} file, and it is important to note that no 
warning is given if a file is to be overwritten by this action.
@endnode

@node MenuSaveAs "Menu option - Save As..."
@{b}@{u}Menu option - Save As...@{ub}@{uu}
Menu:           Project
Shortcut:       Right-Amiga + A
Purpose:        Save the current document via a file requester

Usage:
Selecting this option will open a standard ASL save requester from which a 
file can be chosen. Clicking on Save will write the current document to disk
as a @{"TextEngine format" link TextEngineFileFormat} file, and a warning will be given if a file will be 
overwritten in the process. The operation can be aborted by clicking on 
Cancel.
@endnode

@node MenuASCIISave "Menu option - ASCII Save..."
@{b}@{u}Menu option - ASCII Save...@{ub}@{uu}
Menu:           Project
Shortcut:       None
Purpose:        Save the current document in ASCII format

Usage:
Selecting this option will open a standard ASL save requester from which a 
file can be chosen. Clicking on Save will write the current document to disk
as an ASCII format file, and a warning will be given if a file will be 
overwritten in the process. The operation can be aborted by clicking on 
Cancel.
@endnode

@node MenuPrintPreview "Menu option - Print Preview"
@{b}@{u}Menu option - Print Preview@{ub}@{uu}
Menu:           Project
Shortcut:       None
Purpose:        Display a print preview within a window

Usage:
Selecting this option will open a the @{"Print Control window" link PrintControl}, and a standard 
Console window in which a representation of how the document would look if 
printed on paper is displayed.

The preview begins from the top of the document, and is useful in checking 
that the text is formatted correctly relative to the printer borders. The 
preview will finish when the end of the document is reached, or can be 
stopped sooner by clicking on Cancel within the Print Control window.
@endnode

@node MenuPrintDocument "Menu option - Print Document..."
@{b}@{u}Menu option - Print Document...@{ub}@{uu}
Menu:           Project
Shortcut:       Right-Amiga + P
Purpose:        Print the current document to the printer or disk file

Usage:
Selecting this option will open the Printer Settings window where the 
printer set-up can be checked and altered if necessary. If at this stage 
you do not wish to print the document, click on Cancel within the Printer 
Settings.

Clicking on OK will close the Printer Settings window and, on successfully 
opening the printer file, the @{"Print Control window" link PrintControl} will open and printing 
will commence. The operation can be stopped at any time by clicking on 
Cancel within the Print Control window.
@endnode

@node PrintControl "Print Control window"
@{b}@{u}Print Control window@{ub}@{uu}
Whilst a document is being printed, a small window is displayed showing the 
percentage of the file that has actually been printed. Also present in this 
window is a Cancel button which can be used to abort the printing at any 
point.
@endnode

@node MenuAbout "Menu option - About..."
@{b}@{u}Menu option - About...@{ub}@{uu}
Menu:           Project
Shortcut:       Right-Amiga + ?
Purpose:        Display TextEngine copyright notice

Usage:
Selecting this option will display TextEngine's copyright notice, as well as
my postal and e-mail addresses, just in case you get that urge to become a 
@{"registered user" link Shareware} (go on, you know it makes sense)!
@endnode

@node MenuQuit "Menu option - Quit..."
@{b}@{u}Menu option - Quit...@{ub}@{uu}
Menu:           Project
Shortcut:       Right-Amiga + Q
Purpose:        Unload TextEngine

Usage:
Selecting this option will open a requester querying your choice. Selecting 
OK will quit TextEngine and unsaved changes made to your document will be 
lost. If you change your mind you can click on Cancel to return to the text 
editor window.
@endnode

@node MenuCut "Menu option - Cut"
@{b}@{u}Menu option - Cut@{ub}@{uu}
Menu:           Edit
Shortcut:       Right-Amiga + X
Purpose:        Cut a block of text from the document

Usage:
Having marked a text block, selecting this option will copy the block into 
the cut buffer and then delete it from the document. The text block can then
later be @{"pasted" link MenuPaste} back into the document elsewhere.

The maximum amount of text that can be cut is limited only by the amount of 
free memory there is available. Also, if a text block has not been marked 
then this option will have no effect.
@endnode

@node MenuCopy "Menu option - Copy"
@{b}@{u}Menu option - Copy@{ub}@{uu}
Menu:           Edit
Shortcut:       Right-Amiga + C
Purpose:        Copy a block of text from the document

Usage:
Having marked a text block, selecting this option will copy the block into 
the cut buffer with the block remaining in the document. The text block can 
then later be @{"pasted" link MenuPaste} into the document elsewhere.

The maximum amount of text that can be copied is limited only by the amount 
of free memory there is available. Also, if a text block has not been 
marked then this option will have no effect.
@endnode

@node MenuPaste "Menu option - Paste"
@{b}@{u}Menu option - Paste@{ub}@{uu}
Menu:           Edit
Shortcut:       Right-Amiga + V
Purpose:        Paste a block of text into the document

Usage:
Once a text block has either been @{"cut" link MenuCut} or @{"copied" link MenuCopy} from the document, 
selecting this option will insert that text back into the document at the 
current cursor position.

If a text block has not previously been cut or copied then this option will 
have no effect.
@endnode

@node MenuFind "Menu option - Find..."
@{b}@{u}Menu option - Find...@{ub}@{uu}
Menu:           Edit
Shortcut:       Right-Amiga + F
Purpose:        Input string to be found and optional replace string

Usage:
Selecting this option opens a window into which two text strings can be 
entered. The Find string contains the text to be searched for within the 
document. The Replace string is optional and contains the text with which 
matching occurrences of the Find string within the document may be replaced 
with.

Once these strings have been edited, clicking on OK will move the cursor to
the next occurrence of the Find string within the document. When a match 
has been found, it can be replaced with the Replace string by selecting the 
@{"Replace" link MenuReplace} menu option. To move on to the next occurrence within the document, 
select the @{"Find Again" link MenuFindAgain} menu option.

If no matches are found then the screen will flash indicating an error.
@endnode

@node MenuFindAgain "Menu option - Find Again"
@{b}@{u}Menu option - Find Again@{ub}@{uu}
Menu:           Edit
Shortcut:       Right-Amiga + G
Purpose:        Find next occurrence of the find string

Usage:
Selecting this option will search through the document and place the cursor 
on the next occurence of the Find string (as defined in the @{"Find" link MenuFind} menu 
option).

If no matches are found then the screen will flash indicating an error.
@endnode

@node MenuReplace "Menu option - Replace"
@{b}@{u}Menu option - Replace@{ub}@{uu}
Menu:           Edit
Shortcut:       Right-Amiga + R
Purpose:        Replace currently found text with replace string

Usage:
After a match has been found to the Find string within the document, 
selecting this option will replace the found text with the Replace string 
(as defined in the @{"Find" link MenuFind} menu option).

Once the text has been replaced, the next matching occurrence of the Find 
string will then be found automatically, or the screen will flash in error 
if no more matches are found.
@endnode

@node MenuBold "Menu option - Bold"
@{b}@{u}Menu option - Bold@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Toggle bold text

Usage:
Selecting this option will insert a bold text (inverted B) control character
into your document at the cursor position. Every occurrence of this 
character within the document will toggle bold text on or off when the 
document is printed.
@endnode

@node MenuItalic "Menu option - Italic"
@{b}@{u}Menu option - Italic@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Toggle italic text

Usage:
Selecting this option will insert an italic text (inverted I) control 
character into your document at the cursor position. Every occurrence of 
this character within the document will toggle italic text on or off when 
the document is printed.
@endnode

@node MenuUnderline "Menu option - Underline"
@{b}@{u}Menu option - Underline@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Toggle underline text

Usage:
Selecting this option will insert an underline text (inverted U) control 
character into your document at the cursor position. Every occurrence of 
this character within the document will toggle underline text on or off 
when the document is printed.
@endnode

@node MenuCondensed "Menu option - Condensed"
@{b}@{u}Menu option - Condensed@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Toggle condensed text

Usage:
Selecting this option will insert a condensed text (inverted C) control 
character into your document at the cursor position. Every occurrence of 
this character within the document will toggle condensed text on or off 
when the document is printed.
@endnode

@node MenuDoubleStrike "Menu option - Double Strike"
@{b}@{u}Menu option - Double Strike@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Toggle double strike text

Usage:
Selecting this option will insert a double strike text (inverted D) control 
character into your document at the cursor position. Every occurrence of 
this character within the document will toggle double strike text on or off 
when the document is printed.
@endnode

@node MenuElite "Menu option - Elite"
@{b}@{u}Menu option - Elite@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Set elite text

Usage:
Selecting this option will insert an elite text (inverted e) control 
character into your document at the cursor position. This character can only
turn elite text on when the document is printed, and is cancelled by the 
@{"pica" link MenuPica} control character.
@endnode

@node MenuEnlarged "Menu option - Enlarged"
@{b}@{u}Menu option - Enlarged@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Toggle enlarged text

Usage:
Selecting this option will insert an enlarged text (inverted E) control 
character into your document at the cursor position. Every occurrence of 
this character within the document will toggle enlarged text on or off 
when the document is printed.
@endnode

@node MenuPica "Menu option - Pica"
@{b}@{u}Menu option - Pica@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Set pica text

Usage:
Selecting this option will insert a pica text (inverted p) control character
into your document at the cursor position. This character can only turn 
pica text on when the document is printed, and is cancelled by the @{"elite" link MenuElite}
control character.
@endnode

@node MenuSubscript "Menu option - Subscript"
@{b}@{u}Menu option - Subscript@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Toggle subscript text

Usage:
Selecting this option will insert a subscript text (inverted s) control 
character into your document at the cursor position. Every occurrence of 
this character within the document will toggle subscript text on or off 
when the document is printed.
@endnode

@node MenuSuperscript "Menu option - Superscript"
@{b}@{u}Menu option - Superscript@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Toggle superscript text

Usage:
Selecting this option will insert a superscript text (inverted S) control 
character into your document at the cursor position. Every occurrence of 
this character within the document will toggle superscript text on or off 
when the document is printed.

@endnode

@node MenuPlain "Menu option - Plain"
@{b}@{u}Menu option - Plain@{ub}@{uu}
Menu:           Format
Shortcut:       None
Purpose:        Set plain text

Usage:
Selecting this option will insert a plain text (inverted P) control 
character into your document at the cursor position. Every occurrence of 
this character within the document cancels all of the currently set text 
styles and can be used as a quick method of turning off many text styles at 
once.
@endnode

@node MenuWordCount "Menu option - Word Count..."
@{b}@{u}Menu option - Word Count...@{ub}@{uu}
Menu:           Tools
Shortcut:       Right-Amiga + W
Purpose:        Display the number of words, lines and pages in the document

Usage:
After selecting this option TextEngine will pause for a short while to look 
through the document. When done, a requester will open displaying the number
of words contained within the document, and the number of lines and pages 
the document spans.
@endnode

@node MenuTopOfFile "Menu option - Top Of File"
@{b}@{u}Menu option - Top Of File@{ub}@{uu}
Menu:           Tools
Shortcut:       Right-Amiga + T
Purpose:        Place cursor at the top of the document

Usage:
Selecting this menu option will place the cursor on the first line of the 
document.
@endnode

@node MenuEndOfFile "Menu option - End Of File"
@{b}@{u}Menu option - End Of File@{ub}@{uu}
Menu:           Tools
Shortcut:       Right-Amiga + E
Purpose:        Place cursor at the end of the document

Usage:
Selecting this menu option will place the cursor on the last line of the 
document.
@endnode

@node MenuCentreLine "Menu option - Centre Line"
@{b}@{u}Menu option - Centre Line@{ub}@{uu}
Menu:           Tools
Shortcut:       Right-Amiga + Y
Purpose:        Centralise the current line within the printer borders

Usage:
Selecting this option will insert or delete spaces from the beginning of the
current line in order to centralise it relative to the left and right print 
borders.

If the current line extends past the right print margin then selecting this 
option will have no effect.
@endnode

@node MenuWordWrap "Menu option - Word Wrap"
@{b}@{u}Menu option - Word Wrap@{ub}@{uu}
Menu:           Settings
Shortcut:       Right-Amiga + L
Purpose:        Toggle the word wrapper on/off

Usage:
Selecting this option toggles the word wrapper on or off. When the word 
wrapper is switched off, lines can be edited up to 240 characters in length.
@endnode

@node MenuShowBorders "Menu option - Show borders"
@{b}@{u}Menu option - Show Borders@{ub}@{uu}
Menu:           Settings
Shortcut:       Right-Amiga + H
Purpose:        Show/hide the visible print border guides

Usage:
Selecting this option toggles the print border guides on or off. Please note
that the word wrapper may still be switched on even when the print border 
guides are switched off.
@endnode

@node MenuPrinter "Menu option - Printer..."
@{b}@{u}Menu option - Printer...@{ub}@{uu}
Menu:           Settings
Shortcut:       Right-Amiga + D
Purpose:        Edit the printer borders and other printer options

Usage:
Selecting this option will open a window containing various printer options,
as follows:

Top margin:           This value sets the number of blank spaces at the top 
                      of each printed page.

Bottom margin:        This value sets the number of blank spaces at the 
                      bottom of each printed page.

Page length:          This value must be set to the maximum number of lines 
                      that you printer can print on one page.

Left margin:          This value sets the left margin width, measured in 
                      characters.

Right margin:         This value sets the right margin width, measured in 
                      characters.

Page width:           This value must be set to the width of your paper, 
                      measured in characters (normally 80 for A4 paper).

Print destination:    Here you can enter the filename to which the document 
                      will be printed.
                        e.g. PRT:      - output to the printer.device.
                             df0:print - output to a disk file.

Draft print:          Selecting this option will turn off NLQ printing.

Proportional spacing: Selecting this option will turn on proportional 
                      character spacing.

Double line spacing:  Selecting this option will turn on double line 
                      spacing.

Number of copies:     This value determines the number of copies of the 
                      document that are printed. 

When you have finished entering your printer settings, clicking on OK will 
make the changes effective. Selecting Cancel will return the printer 
settings to the previously entered values.
@endnode

@node MenuFunctionKeys "Menu option - Function Keys..."
@{b}@{u}Menu option - Function Keys...@{ub}@{uu}
Menu:           Settings
Shortcut:       Right-Amiga + K
Purpose:        Assign text strings to the ten function keys

Usage:
Selecting this option opens a window containing ten string gadgets. Using 
these you can assign text strings of up to 256 characters in length to each 
of the ten function keys (F1 - F10). Then, when editing your document, 
pressing a function key will automatically insert the corresponding text 
string.
@endnode

@node MenuColours "Menu option - Colours..."
@{b}@{u}Menu option - Colours...@{ub}@{uu}
Menu:           Settings
Shortcut:       Right-Amiga + M
Purpose:        Alter the colours of the text editor window

Usage:
Selecting this option opens a window containing two palette gadgets. These 
give a choice of up to 8 different colours (depending on your screen mode) 
and can be used to choose the text and field colours of the text editor 
window.
@endnode

@node MenuSaveSettings "Menu option - Save Settings"
@{b}@{u}Menu option - Save Settings@{ub}@{uu}
Menu:           Settings
Shortcut:       None
Purpose:        Save the settings to disk

Usage:
Selecting this option saves TextEngine's current preferences settings to the
TextEngine5.0.cfg file. The settings saved within this file are as follows:

        - Word wrap setting.
        - Print border guides setting.
        - Draft print setting.
        - Proportional character spacing setting.
        - Double line spacing setting.
        - Number of print copies.
        - Printer margin settings.
        - Print destination filename.
        - Text editor window colour settings.
        - Function key text strings.
@endnode

@node MenuOpenDictionary "Menu option - Open Dictionary"
@{b}@{u}Menu option - Open Dictionary@{ub}@{uu}
Menu:           Spell
Shortcut:       Right-Amiga + B
Purpose:        Load the spelling checker's dictionary file

Usage:
When TextEngine is loaded, it does not automatically load in its dictionary 
file. Instead, if you want to use the spelling checker you must first select
this option to load the dictionary into memory. If the operation is 
successful you will find that the Spell menu has been unghosted, and the 
other options are now available.

The dictionary requires at least 300KB free memory, so users with only 1MB 
total RAM may find they are unable to open the dictionary whilst they are 
editing a fairly long document. An error message will be displayed if there 
is not enough memory available.
@endnode

@node MenuCloseDictionary "Menu option - Close Dictionary"
@{b}@{u}Menu option - Close Dictionary@{ub}@{uu}
Menu:           Spell
Shortcut:       None
Purpose:        Close the spelling checker's dictionary file

Usage:
Selecting this option will remove the dictionary from memory, freeing about 
300KB of RAM in the process.
@endnode

@node MenuUpdateDictionary "Menu option - Update Dictionary"
@{b}@{u}Menu option - Update Dictionary@{ub}@{uu}
Menu:           Spell
Shortcut:       None
Purpose:        Save the dictionary (plus added words) back to disk

Usage:
After using the spelling checker to check your document, you may have added 
some words to the dictionary. Selecting this option saves the entire 
dictionary, plus your additions, back to disk.
@endnode

@node MenuCheckDocument "Menu option - Check Document..."
@{b}@{u}Menu option - Check Document...@{ub}@{uu}
Menu:           Spell
Shortcut:       Right-Amiga + J
Purpose:        Check the document's spelling

Usage:
Selecting this option will open the Spelling Checker window, and TextEngine 
will begin checking the document from the current cursor position. When a 
potentially incorrect word is found, it is displayed in the Unknown text 
gadget and a list of suggestions as to its correct spelling are displayed in
list gadget. If you wish to ignore the word, simply click on Ignore and the 
spelling checker will continue checking the document.

If the word is correctly spelt, it can be added to TextEngine's dictionary 
by clicking on Learn. This will store the word and then continue checking 
through the document. After the spelling checker has finished, you can 
select the @{"Update dictionary" link MenuUpdateDictionary} menu option to permanently store any additions 
made to the dictionary on disk.

If the word is incorrectly spelt, you can select a replacement by simply 
clicking on one of the suggestions from the list. Alternatively you can type
your own replacement into the Replace With string gadget. Once you have 
chosen a replacement, simply click on the Replace button to automatically 
correct the word in the document.

If you wish to stop the spelling checker, simply click on the Cancel button.
@endnode

@node EditingText "Editing text"
@{b}@{u}Editing text@{ub}@{uu}

       @{"Using the keyboard    " link UsingTheKeyboard}    Editing a document
       @{"Adding text styles    " link "AddingTextStyles}    Improving your document's appearance
       @{"Cutting & Pasting text" link Cutting&Pasting}    Moving blocks of text around
@endnode

@node UsingTheKeyboard "Using the keyboard"
@{b}@{u}Using the keyboard@{ub}@{uu}
Editing text in TextEngine is just like any other text editor you may have 
used in the past. Text can be entered with either the @{"word wrap" link MenuWordWrap} on or off. 
When switched on, the word wrap will wrap the last word of the current line 
onto the one below whenever the current line becomes wider than the width of
the page (as defined in the @{"printer settings" link MenuPrinter} menu option). With the word 
wrap switched off, the printer borders are ignored and lines up to 240 
characters long can be edited.

The cursor keys can be used to move around the document, and holding down 
Shift whilst using the up and down cursor keys allows you to move up and 
down a page at a time.

Each of the ten function keys (F1 - F10) can be assigned a text string (as 
defined in the @{"function keys settings" link MenuFunctionKeys} menu option), and when one of these 
keys is pressed, its corresponding text will automatically be entered into 
your document.
@endnode

@node AddingTextStyles "Adding text styles"
@{b}@{u}Adding text styles@{ub}@{uu}
TextEngine allows you to alter the way in which your text is printed so as 
to help you make your documents clearer and easier to read. It does this by 
allowing you to insert control characters into your document which set a 
style for the text which follows them.

Text styles are inserted by selecting options from the Format menu. The 
following styles are available, but it is important to note that not all 
printers support them all, so just try them out and see which ones work.

@{u}Style           Description                                     Control char@{uu}
@{"Bold         " link MenuBold}  Doubles the thickness of text horizontally.     @{bg text}@{fg background}B@{bg background}@{fg text}
@{"Italic       " link MenuItalic}  Slants text to the right.                       @{bg text}@{fg background}I@{bg background}@{fg text}
@{"Underline    " link MenuUnderline}  Draws a line under text                         @{bg text}@{fg background}U@{bg background}@{fg text}
@{"Condensed    " link MenuCondensed}  Sets character pitch to 17 characters per inch. @{bg text}@{fg background}C@{bg background}@{fg text}
@{"Double strike" link MenuDoubleStrike}  Doubles the thickness of text vertically.       @{bg text}@{fg background}D@{bg background}@{fg text}
@{"Elite        " link MenuElite}  Sets character pitch to 12 characters per inch. @{bg text}@{fg background}e@{bg background}@{fg text}
@{"Enlarged     " link MenuEnlarged}  Doubles the width of text.                      @{bg text}@{fg background}E@{bg background}@{fg text}
@{"Pica         " link MenuPica}  Sets character pitch to 10 characters per inch. @{bg text}@{fg background}p@{bg background}@{fg text}
@{"Subscript    " link MenuSubscript}  Set subscripted text.                           @{bg text}@{fg background}s@{bg background}@{fg text}
@{"Superscript  " link MenuSuperscript}  Set superscripted text.                         @{bg text}@{fg background}S@{bg background}@{fg text}
@{"Plain        " link MenuPlain}  Cancel all previously set styles.               @{bg text}@{fg background}P@{bg background}@{fg text}

Using the text styles is very simple. When your document is printed, the 
first occurrence of a text style control character will switch on that style.
It will then remain on until the next occurrence of that control character, 
which switches off the text style. This is true for all of the text styles 
except Elite and Pica (which cancel each other), and Plain.

@{u}Example@{uu}
Say you entered the following text into TextEngine:

                                @{bg text}@{fg background}U@{bg background}@{fg text}SHOCK HORROR!@{bg text}@{fg background}U@{bg background}@{fg text}
@{bg text}@{fg background}I@{bg background}@{fg text}TextEngine@{bg text}@{fg background}I@{bg background}@{fg text} can apply all kinds of @{bg text}@{fg background}B@{bg background}@{fg text}styles to your text.

When printed, the resulting output would look like this:

                                @{u}SHOCK HORROR!@{uu}
@{i}TextEngine @{ui}can apply all kinds of @{b}styles to your text.@{ub}
@endnode

@node Cutting&Pasting "Cutting, copying, and pasting text"
@{b}@{u}Cutting, copying, and pasting text@{ub}@{uu}
TextEngine allows you to move large blocks of text around the document 
quickly and easily. To mark a text block, place the mouse pointer over the 
first line of the block. Then, while holding down the left mouse button, 
drag the mouse down to the last line of the block. You should now see your 
block of text highlighted in inverted type.

Once a text block has been marked, options in the Edit menu allow you to 
@{"copy" link MenuCopy}, or @{"cut" link MenuCut} the block into the cut buffer. Once this has been done, the 
cursor can be moved to another part of the document, and the text @{"pasted" link MenuPaste} 
back in.
@endnode

@node HandlingFiles "Handling files"
@{b}@{u}Handling files@{ub}@{uu}
TextEngine supports two types of file format; @{"TextEngine format" link TextEngineFileFormat} files; and 
ASCII format files.

Files are handled by selecting the following options from the Project menu:

  @{"Open...       " link MenuOpen}    Load in and ASCII or TextEngine format file.
  @{"Insert file..." link MenuInsertFile}    Insert an ASCII or TextEngine file into the document.
  @{"Save          " link MenuSave}    Save the document as a TextEngine format file.
  @{"Save As...    " link MenuSaveAs}    Like Save, except a file requester is used.
  @{"ASCII Save... " link MenuASCIISave}    Save the document as an ASCII format file.

Also, a new feature of TextEngine V5.0 allows files to be loaded from 
Workbench by simply dragging their icons onto TextEngine's window.
@endnode

@node TextEngineFileFormat "TextEngine file format"
@{b}@{u}TextEngine file format@{ub}@{uu}
TextEngine's file format for version 5.0 is similar to ASCII, except that 
each file has a block of data attached to it containing the following 
information:

        - Word wrap setting.
        - Print border guides setting.
        - Draft print setting.
        - Proportional character spacing setting.
        - Double line spacing setting.
        - Number of print copies.
        - Printer margin settings.
        - Print destination filename.
        - Text editor window colour settings.
        - Function key text strings.

Saving your work as TextEngine format files allows each of your documents 
to have their own individual preferences settings which TextEngine 
configures to each time they are loaded. This can be useful if you want to 
change the printer set-up or window colours for one particular document 
without having to change TextEngine's main settings.

It is important to note that TextEngine V5.0 does not support TextEngine 
format files from previous versions. However, upgrading users can easily 
load their old documents into TextEngine V5.0 by saving them as ASCII 
format files first.
@endnode

@node SpellingChecker "The spelling checker"
@{b}@{u}The spelling checker@{ub}@{uu}
TextEngine features a fully functional spelling checker which is useful for 
checking documents for spelling and typing errors. Included is an English 
language dictionary file (TextEngine5.0.dct) which contains over 36,000 
words. However, this by no means covers every word in existence, so it is 
always worth having a dictionary nearby in order to check words which 
TextEngine has not seen before!

To start the spelling checker up for the first time, you must select the 
@{"open dictionary" link MenuOpenDictionary} option from the Spell menu. If this operation is successful 
then the rest of the Spell menu becomes available, giving you full control 
over the spelling checker, as follows:

  @{"Close dictionary " link MenuCloseDictionary}    Release the memory used by the spelling checker.
  @{"Update dictionary" link MenuUpdateDictionary}    Save the additions made to the dictionary.
  @{"Check document..." link MenuCheckDocument}    Check the spelling of the document from the cursor.
@endnode

@node ThanksTo "Thanks to..."
@{b}@{u}Many thanks for the support I have had from the following people:@{ub}@{uu}
John Reece, Michael Amoah, Paul Burnham, M Rhodes, C Ralfe, Ian Rawlings, G 
Lambert, S May, Stan Davey, R Evans, P Sullivan, David McClay, E Berney, 
John Ellis, J Jarret, Gary Shaw, R Chambers, P Berg, Peter Stubbs, Graeme 
McGibbon, D Simons, Len Mullenger, Alan Lingard, Christopher Jones, Sheila 
Walsh, Pauli Hietala (hello Finland!), Andrew Chambers, A Gravener, C 
Wellman, R Minns, Ken Spry, 17 Bit, Deltrax, David Aslett, Bill Sloan, 
Keith Pang, D Davies, Victor Hunt, J Bryer, B Wyatt, Ernest Wilson, Larry 
Cashill, Dennis Brunskill, Roy Pearson, N Peters, Colin Curtis, W Davies, 
Tony Campbell, T Dullage, Frank Mitchell, Jim Finney, Graham Adair, Tony 
Davies, R Robertson, Marcus Ong, Ian Ridehalgh, Cyril Stacey, Adrian Nudel, 
Paul Hayball, M F Sheard, John Perks, P L Hammour, P R Thomas, Gillian 
Beton, Denis Pycroft, Geoff Bowell, Richard Dockett, Mr & Mrs Dickinson, J 
Rimington, Jagdeep Lall, Piers Kurrein, Russell Tippett, Ian Seth, R 
Blayney, George Johnston, Peter Hind, Robert Iveson, J E Standley, Geoff 
Thomas, Rocky Daly, Adrian Back, William Mutch, Roger Coleman, Dave Hawley, 
Colin Standley, Archie Allison, Ricky Clarke, G M Nicholas, Turtle 
Lightning Amiga Software (Texas, USA!), Kate Simmonds, Michael Taylor, M 
Newsham, Colin Coomber, Alex Kane, Tony Green, Robert Lake, Jen Allen, D 
Mead, P G Rayner, Alan Holdsworth, Bill Heasman, Ian Ferris, Mark Jones, 
Kieran Foote, Jeff Fuller, John & Pat Bigland, B Thompson, Sam Holden (Viva 
Espana!), Walter Jones, G Holmes, Gerry Jowett, R H A Forrester, G R Bevan, 
Tim Bairstow, R R James, A Hodge, Michael Reynolds, Jan Moller Kristensen 
(hi Denmark!), Alexander Wingrove, Andrew Aldridge, A Marriott, Robert 
Beavan, Jim Wilkins, E A Hayles, Paul Roberts, R Walsh, P McDermott, Michael
Hipgrave, Geoffrey Jones, Peter Harris, Keith Hyams, Ieuan Owen, Jamie Dunn,
Anthony Kelly, Mark Hutchins, Lionel Kelly, Janet Thomas, Stewart Anderson, 
D W Daykin, Josh Hayles, Bryan Kelly, P A Edwards, Carol Biggs, David Self, 
A C J Whelton, Paul Whatton, Ian Aisbitt, Stan Whalley, and Mum and Dad.

Hello to:
Esher Racing: Mark Higgins, and Martin Guy.
Loughborough University: Steve Williamson, Mark Perry, Paul Hyde, Rob 
"Chuzzle Papmore" Passmore, Dave Clay, and Emlyn 7.
The Bakery at Safeway Cromer: Emma, Janice, Claire, Lucy, Elizabeth, Naomi, 
Chris, Darren, and everyone else.
And hellos also to Scott Lewis, Phil Hicks, and Piers Bolton.

Which leaves me to say thanks a lot for taking a look at my program. Look 
out for TextEngine 95, due for release early next year (only kidding)!

Signed: Nick, 12 September 1995.
@endnode