Black Box 4/BlackBox.cdr/editors/ianedv21.arj/IANED.DOC

Text File | 1991-04-24 | 21KB | 517 lines

                            IANED Version 2.0

                             COPYRIGHT 1990

                                   by

                             OS Systems Ltd.

                           ALL RIGHTS RESERVED


IANED is NOT free software. You are granted a limited licence to use IANED
for a limited period (30 days), for evaluation purposes only. Use beyond
this evaluation requires you to register this software. See REGISTER.DOC
on the distribution disk for registration details. The program and the
associated documentation on disk may be freely distributed on the
following conditions:

      No changes whatsoever are made to the program or its documentation.

      No charge is made for its distribution (exceptions will be made for
      authorised disk duplication services - No charge will be made for
      this authorisation but I need to know who is distributing the program
      so that I can send out updates - please write to the address at the
      end of this document).


LIMITED WARRANTY

For registered users, and users who have obtained IANED directly from the
OS Systems Ltd,  who warrant that the distribution disk is an accurate
reproduction of the software. In the event of any defect in the duplication
process OS Systems Ltd will replace the disk, as long as it is returned
within 30 days of receipt. No other warranty, implicit or otherwise,
including but not limited to merchantability or fitness for any particular
purpose, is made. Under no circumstances will OS Systems Ltd be liable for
any loss or damage suffered by any user arising out of the supply, use, or
operation of this software, whether such loss or damage be direct,
consequential or otherwise.
Features

      ■    WordStar compatible commands
      ■    Full search and replace with global and case sensitive options
      ■    Copy and move blocks
      ■    Import and export blocks of text from and to other files
      ■    Wordwrap and centre text
      ■    Adjustable right margin
      ■    Can be run either from DOS or as a TSR (memory resident, or
           pop-up like Sidekick)
      ■    Swaps out of memory when not popped up when loaded as a TSR
      ■    Uses only 7K of RAM when loaded as a TSR
      ■    Use expanded or extended memory, or disk for swapping to when
           run as a TSR
      ■    Mouse compatible
      ■    Edit files up to size of memory
      ■    Can also be unloaded completely from memory when resident
      ■    Remembers cursor position in current file when loaded as a TSR
      ■    Built in ASCII and scan code table in re-sizable and moveable
           window
      ■    Built in multi function Calculator
      ■    Built in Calendar
      ■    Pop-up indexed hypertext help
      ■    User configurable keystrokes
      ■    Configure default path, filemask and extension for files to be
           edited
      ■    User configurable colours
      ■    Full installation program supplied to configure program
           defaults
      ■    Pull down menus
      ■    Clipboard allows you to cut and paste between different files





Files on the Disk

      IANED.EXE       the editor program
      EDIT.HLP        the help files
      IANINST.EXE     the installation program
      IANED.DOC  the manual
      REGISTER.DOC    registration details for IANED


What's New in Version 2.0

1.    Pull down menus with context sensitive help for each menu item.

2.    Can now edit files up to the size of memory instead of the old 64K
      limit.

3.    Clipboard allows text to be cut, copied and pasted between different
      files.

4.    Added many more user configurable colours.

5.    Shareware screen only displayed once at beginning of program.

                           TABLE OF CONTENTS

1     Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  1

2     Installation . . . . . . . . . . . . . . . . . . . . . . . . .  2

3     Obtaining Help . . . . . . . . . . . . . . . . . . . . . . . .  2

4     Using IANED in Resident and Non Resident Mode. . . . . . . . .  2

5     Using the Pull Down Menus. . . . . . . . . . . . . . . . . . .  4

6     The Status Line. . . . . . . . . . . . . . . . . . . . . . . .  5

7     Loading a File into IANED. . . . . . . . . . . . . . . . . . .  5

8     Saving a File. . . . . . . . . . . . . . . . . . . . . . . . .  7

9     Smart Tabs . . . . . . . . . . . . . . . . . . . . . . . . . .  7

10    Auto Indent. . . . . . . . . . . . . . . . . . . . . . . . . .  7

11    Using the Pop-Up Calculator. . . . . . . . . . . . . . . . . .  7

12    Using the Pop-Up Calendar. . . . . . . . . . . . . . . . . . .  8

13    Using the Pop-Up Programmer's Reference Table. . . . . . . . .  8

14    Using IANED with Sidekick. . . . . . . . . . . . . . . . . . .  8

15    Function Key Assignments in IANED. . . . . . . . . . . . . . .  8

16    The Installation Program IANINST . . . . . . . . . . . . . .   10

17    Acknowledgements . . . . . . . . . . . . . . . . . . . . . .   14

1     Introduction

      IANED is a WordStar compatible text editor that you can run as a
normal DOS program, or as a swapable TSR. If run as a swapable TSR the
program leaves only a small resident kernel in normal memory. The rest of
the program is swapped out either to disk, expanded, or extended memory.
When the hot-key is pressed the non resident portion of the program is
loaded either from the disk swap file, or expanded memory and the program
pops up. This technique ensures that the program only uses the minimum of
conventional memory when run as a TSR, leaving you plenty of room to load
other TSR's, or normal DOS applications.

      In addition to recognising WordStar commands IANED also has a
system of pull down menus, for users who are not familiar with WordStar.
There is also an integrated context sensitive hypertext help system,
which should make it almost completely unnecessary to refer to the manual.

      Several of the most commonly used items are mapped to Function keys
e.g. F2 to search and F10 to save the current file, in addition to the
WordStar equivalents.

      There is a separate configuration program IANINST, which allows you
to tailor many features of IANED such as colours and key commands to your
own tastes.

      The following is an abbreviated version of the full manual. However,
by reading this and using the hypertext help you will be able to use all the
features of IANED.
2    Installation

      To install IANED simply copy the files IANED.EXE, IANINST.EXE and
EDIT.HLP to the subdirectory or disk from where you wish to run the editor.


3     Obtaining Help

      To obtain help on a topic, press F1 while in the normal editing
screen. This will open the Help Topics window. Select the topic that you
want help with using the cursor keys and press <RETURN> to see that topic.
Pressing Esc will return you to the Topic Menu and pressing Esc again will
return you to Editing Mode.

      Whilst using any of the menus pressing F1 will give you help specific
to that menu item. You can also obtain help when using the Calculator,
Programmer's Reference and Calendar by pressing F1. Pressing F1 when the
help window is showing help for a specific item will show you the help
index.

      The help system maintains a stack of the last 12 help screens that
you have viewed. You can cycle back through these by pressing Alt-F1 while
in the Help Window.

      If you need any further help, or have any suggestions you can contact
OS Systems at Units 2/4, 19 Spring Gardens, Buxton SK17 6BX, England. You
can also reach us by EMAIL on CIX as ibarton.@cix, on Compuserve
100012,533 or on our own BBS (High Peak BBS) on 0298 872474.


4     Using IANED in Resident and Non Resident Mode

      To load the Editor as a normal DOS program, simply type IANED /n at
the DOS prompt. When you exit the Editor it will be unloaded from DOS as
would any other normal, non resident program.

      To load the Editor as a TSR (pop-up) simply type IANED at the DOS
prompt. To pop up the Editor over another DOS application hold down the Alt
key and press the Tab key. The message "Swapping In" while the non-
resident portion of the Editor is loaded from the disk, or expanded
memory. The default hot keys can be modified by using the configuration
program IANINST.

      Please note that you cannot run IANED as a TSR unless it is installed
on a hard disk. Trying to do so will produce an error message.
Command Line Switches You Can Use When Loading IANED.

      IANED can be run either as a normal DOS program, or as a TSR. If used
as a TSR the program will swap most of itself out of memory to disk,
expanded, or extended memory. When you press the hot-key (Alt-Tab) the
non resident portion of the program is loaded from disk and IANED will
then pop-up. When exiting IANED most of the program, except for a small
RAM resident portion is swapped out to disk, expanded, or extended
memory. This enables the program to minimise the amount of memory that it
uses whilst resident.

      You can use whether the non-resident portion is swapped to disk,
expanded, or extended memory by specifying the appropriate command line
switch when first loading IANED.

/?               Display help screen for command line parameters

/N               Don't load IANED as a TSR

/E               Don't use expanded memory for swap file

/X               Swap to extended memory if available

/A               Use normal, instead of hidden, attributes if swapping to
                 disk

/Ppathname            Specify the pathname to use when swapping to disk

/U               Unload IANED from memory

Examples:

      IANED /N                   Run as a normal DOS program

      IANED /E/A/D:\MYSWAPDIR    Load as a TSR, but don't use expanded
                                 memory for swap file, set swap file
                                 attributes to non-hidden and use
                                 MYSWAPDIR for the swap file


5     Using the Pull Down Menus

      To access any of the menus on the menu bar which is displayed
accross the top of the screen press <Alt-Letter>, where Letter is the
first letter of the menu that you want to access (the only exception is the
Format menu which is <Alt-R>).

      Once a menu has popped down you can select the appropriate item by
moving the highlight bar over it and pressing <RETURN>. You can move to
another menu item along the top menu bar by pressing the left and right
arrow keys.

      Pressing <ESC> will take you to the previous level of submenu. If you
are in the top level menu i.e. only the top menu bar is highlighted,
pressing <ESC> will return you to the editing screen.


6     The Status Line

      The bottom line of the screen shows various items of useful
information (see Fig. 1 below). These are the filename, the current cursor
position, the amount of free memory available, whether IANED is in Insert
or Overtype mode, if Smart Tabs are being used, whether auto-indent is on
and if word wrap is on or off. Finally the word Save appears at the end of
the Status Line if any changes have been made to the text since you last
saved the file.

 NONAME        Line: 1     Col: 2   M Avail   127 Insert Smart Indent Wrap Save
                        Fig. 1 IANED Status Line


7     Loading a File into IANED

      To load a file press Shift-F10 and enter either the name of the file
that you want to load, including the full path if necessary, then press
<RETURN> and the file will be loaded into IANED.

      Alternatively press F5 and you will be prompted for a file name mask.
For example you could enter C:\WP\TEXT\*.DOC. Press <RETURN> and the
Directory Window  will pop up. Using the cursor keys move the highlight
over the file that you want to load and press <RETURN>.

      Directories are shown with a <dir> next to them together with all the
drives on your computer. To change to a different directory move the
cursor over the directory name and press <RETURN>. You can use the same
method to change to a different disk drive.

      You can also bring up the Directory Window via the pull down menus by
selecting the Open option from the File menu.

      You can esacpe from the Directory Window at any time by pressing
<Esc>.
8    Saving a File

      To save the current file press F10. You will be prompted for a
filename, press <RETURN> to accept the default, or enter a new filename.
Filenames can include full path information eg. C:\TEXT\PROGS\MYFILE.DOC. If
the file already exists you will be prompted whether you want to overwrite
it.

      Alternatively you can use the Save option in the File Menu.



9     Smart Tabs

      If smart tabs are on text will be indented to the level of the text on
the previous line when the Tab key is pressed. If Smart Tabsd are
disabled, pressing Tab will indent the text by the fixed tab size (8 by
default, but can be customised in IANINST).



10    Auto Indent

      In auto-indent mode pressing <RETURN> while in Insert mode will
cause the new line to have the same indentation level as the previous line.
This also affects the way that word wrap occurs - the new line will have
the same level of indentation as the previous one. Thus this also affects
the behaviour of the Paragraph and Global re-format commands.




11    Using the Pop-Up Calculator

      When IANED is popped up, you can use the built in Calculator by
pressing F3. The Calculator window can be moved by typing Alt-M and then
using the arrow keys to move the Calculator window around the screen.
Pressing <RETURN> will anchor the Calculator window in place. To close the
Calculator window press Esc. When you pop up the Calculator window again,
it will remember the last position that you moved it to.


12   Using the Pop-Up Calendar

      When IANED is popped up, you can use the built in Calendar by
pressing F4. The Calendar window can be moved by typing Alt-M and then
using the arrow keys to move the Calendar window around the screen.
Pressing <RETURN> will anchor the Calendar window in place. To close the
Calendar window press Esc. When you pop up the Calendar window again, it
will remember the last position that you moved it to.


13    Using the Pop-Up Programmer's Reference Table

      To open the Programmer's Reference window press F9. You can move, or
re-size the window by pressing Alt-M, or Alt-R respectively and using the
arrow keys. To fix the window in place press <RETURN>. To close the window
press Esc. The window will remember its last position and size when it is
opened again.


14    Using IANED with Sidekick

      IANED automatically detects the presence of Sidekick if it is already
loaded if you try to load IANED as a TSR. It displays an error message and
aborts installation. If you wish to use IANED as a TSR with Sidekick, make
sure that you load Sidekick last.


15    Function Key Assignments in IANED

F1        Displays the main help index
F2        Search
Ctrl-F2   Search again
Alt-F2    Search and replace
F3        Pop up calculator
Alt-F3    File pick list (display last 5 files loaded)
F4        Pop up calendar
F5        Display directory listing and load a file
F7        Block on
F8        Block off
F9        Pop up Programmer's Quick Reference
F10       Save named file
Alt-X     Exit IANED



16   The Installation Program IANINST

      The installation program (INST.EXE) must be in the same directory as
IANED.EXE or the directory containing IANED must be on the DOS path. To
start the program type INST at the DOS prompt, this will bring up the main
menu.

      The first four options - Calculator, Calendar, Editor, and Quick
Reference allow the user to configure the keystrokes for each of these
functions. Up to three different key combinations may be specified for
each operation. Pressing the left or right arrow keys will allow you to
move between the particular key combinations for each particular
operation.

      Pressing <RETURN> will pop up a window allowing the key combination
to be edited. Initially the window is in Command mode - shown by the word
Command in the bottom right corner. In this mode the user can store the
new key combination by pressing <RETURN>, restore the default by pressing
Ctrl-R, or clear the window by pressing Ctrl-C. Pressing the Scroll Lock
key will place the window in Literal Mode (shown by Literal in the lower
right hand corner of the window). When a key is pressed in Literal Mode
this is interpreted as one of the keys to use to perform that function eg.
to redefine the Delete to End of Line key combination to Ctrl-End, you
would hold down the Control key and press the End key and <Ctrl><End>
would appear in the window. You can define up to three keys for each
operation.

      The Colours option allows the screen colours used for various
different parts of the program to be customised. You can define two colour
sets one for use on colour screens and the other for use on mono screens.
It is now possible to customize most of the colours used by the program.

      The Options item on the main menu will allow you to select various
defaults to be used when IANED is first loaded:

1.    Primary Hotkey
      The key combination used to make the program pop up. Pressing F10
will display a list of choices for the first key of the hot key combination.
Selecting one of these by pressing <RETURN> will display a second window
of choices, which allow you to specify the second key press.

2.    Hotkey String
      This is the message displayed on screen while the program is going
resident to prompt which key combination to press to pop up the program.

3.   Path for Swapfiles.
      This is the default path for the swap files created when the program
is loaded as a TSR. This must be a hard disk drive, or the program will
display an error message when loaded and loading will be aborted.

4.    Swap Name #1 and #2.
      The names of the two swap files created when the program goes
resident. These are normally created as hidden files, so that they are not
accidentally deleted. However, if you specify the  /A switch when loading
IANED these files will be created with normal attributes.

5.    Use EMS if Available.
      If this is set to Y IANED will use EMS for its swap files if it is
installed. Note that the command line /N command line switch will override
the setting created by the INST program.

6.    Show Swap Message
      This toggles on and off the display of the Swapping and Swapping Out
messages when IANED is loading and unloading from disk or EMS.

7.    Enable Mouse Support
      Toggles mouse support on and off.

8.    Colour Selection
      Toggles between colour, mono or auto selection of display type.

9.    Auto Indent
      Toggles auto indent after Enter is pressed.

10.   Delete Joins Lines
      Determines whether you can join separate lines by using the Delete
key.

11.   Indent Starts Paragraph.
      Determines whether an indent toggles a new paragraph when text is
reformatted. If this is set to N all text not separated by a carriage
return is considered to be part of the same paragraph and will be
reformatted as such.

12.   Smart Tabs
      Toggles Smart tabs on or off.

13.   Tab Size
      The default tab size when the Editor is first started. However, the
tab size can be changed from within the editor by pressing

14.   Word Wrap
      Toggles word wrapping at the right margin.

15.   Wrap at Column 1
      Toggles wrapping to the left from column 1.

16.  Make Backup Files
      If set to Y, every time a file is saved the old file is first copied to
the same file name with the extension BAK.

17.   Read Partial Files.
      If this set to Y and you try to read a file larger than the maximum
permitted size into the editor it will be truncated when the edit buffer is
full. If this is set to N, an error message will be displayed and the file
will not be loaded.

18.   Default Extension
      The default extension to be used when prompting for filenames and
appended when saving files.

19.   Default Path/File Name.
      The default path and filename or file-mask to be used when prompting
for files eg. C:\TEXT\MYFILE*
      Do not append a period to the end of the file-mask as the program
does this automatically for you:

C:\TEXT\MYFILE*.   - incorrect
C:\TEXT\MYFILE*   -  correct. Display all files in the directory TEXT
beginning with MYFILE.

20.   Default Printer Port.
      Set the default port for printing from IANED. The valid range is Lpt1-
3.

17    Acknowledgements

IANED was written in Turbo Pascal 6.0 using Turbo Power's Object
Professional library. Steve Sneed provided the unit which allows IANED to
use files as big as memory.