@database PlusEd
@master PlusEd.guide
@index index

Written by Stefan Zeiger
Copyright (c) 1992-1994 by ! Wizard Works !
All rights reserved

@Remark $VER: PlusEd.guide 2.1 (29.11.94) English



@node main "PlusEd 2.1 documentation"

 @{" Introduction      " link introduction} @{b}                  _        ___ __ _@{ub}
 @{" Installation      " link installation} @{b}                 |_)|  | |(__ |_ | \\ @{ub}
 @{" The main window   " link mainwindow  } @{b}                 |  |__|_|___)|__|_/@{ub}
 @{" Registering       " link registering } @{b}      _      ___ _ __ __ _        __ __  __ __ _@{ub}
 @{" Technical stuff   " link techstuff   } @{b}     |_)\\/  (__ | |_ |_ /_\\ |\\ |   /|_ ||_ |_ |_)@{ub}
 @{" License           " link license     } @{b}     |_)/   ___)| |__| /   \\| \\|  /_|__||_||__| \\ @{ub}

 @{" About             " link "about/main"}        PlusEd 2.1, © 1992-1994 by Stefan Zeiger
 @{" History           " link "/history/main"}               This program is @{"Shareware" link registering}!
@endnode



@node introduction "Introduction"

@{b}Welcome to PlusEd !@{ub}

Now here is the ANSI editor that you've been waiting for !
Er, well... at first it was the ANSI editor that I have been waiting for.
I had just begun to write some ANSI texts for the PLUS BBS and I had already
tried several ANSI editors, but none of them was good enough for me. Some
used either IBM.font or Topaz.font, but not both, others did only have
25 lines for the text and again others were written in BASIC and terribly
slow, and some were...

OK, what I wanted to say was that there is just no really good ANSI editor
for the Amiga. And 'really good' means for me :

- Support for Topaz.font and IBM.font
- OS2.0 new look design
- Localized for OS2.1+
- Color requester
- Comfortable requesters
- Block manipulation funtions
- Writing in other directions than just from left to right
- Manipulating color and text separately
- Drawing lines and boxes with the mouse or keyboard
- High speed

So I decided to write my own ANSI editor, and because I am CoSysop of PLUS
BBS, I called it PlusEd. I implemented everything I needed and many more
things :

- Text length limited to 100 lines instead of 25 (1 screen)
- Support for Topaz and IBM font
- OS2.0/3.0 design with GadTools gadgets & NewLook menus
- Localization; A german catalog is already included; I've also added the
  catalog sources just for the case that you'd like to create a catalog
  for your own language  (If you do so, please send it to me)
- Color presets for Amiga (OS2.0+), ANSI, EGA, DIEd, A2024; Ability to read
  your WB colors; Colors can be saved in your preferences
- Using @{"ReqTools.library" link reqtools} for nice requesters
- Navigation gadgets for writing in all directions
- Separate control of text and style/color
- Drawing lines and boxes (even overlapping ones) with the mouse or keyboard
- Quickwrite function with pre-made ANSI fonts
- Ability to create shadows, a nice 3D design and other amazing effects
- Recalculating IFF pictures into ANSI texts
- Written in highly optimized SAS/C code for maximum speed
...

After 9 months of development (including 4 months of beta-testing) PlusEd 1.00
was finally finished and I released it as Shareware. Then after another 5
months followed PlusEd 2.0. And now - more than one year later - here is PlusEd
release 2.1! Enjoy...

@{b}I'd like to thank the following persons and companies:@{ub}

- The PlusEd beta-testers (in alphabetical order):
  - Kai Iske
  - Jörg Jäger
  - Philipp Lonke
  - Carsten Raufuß
  - Ralf 'Masterbyte' Schäfer
  - Daniel Schrod
  - Norbert 'Feedback' Wigbels
- Stefan Johannesdal for the Swedish translation
- Chris Reichert (SysOp of PUBLISHERS TREFF BBS, the PlusEd support BBS)
- Nico François for ReqTools
- SAS Institute for their great SAS/C C compiler
- Commodore for the AMIGA
- Everyone I have forgotten now
@endnode



@node installation "Installation"

You need OS 2.04 or higher to run PlusEd. I have started developing PlusEd
on an A500 with OS2.0 and later on I switched to an A4000/040 with OS3.0.
PlusEd has been tested on an A500, A1200, A2000 and A4000/040 with OS 2.04,
2.1, 3.0 and 3.1 and it worked well with all configurations.

The installation for @{b}OS2.1 or higher@{ub} is simple. Just start the appropriate
installation script and answer the questions. If you are still using @{b}OS2.04@{ub}
you have to copy PlusEd where you want it and install the IBM.font in fonts:
and the @{"reqtools.library" link reqtools} and triton.library in libs:.

It is not possible to run PlusEd in any other language than English below
OS 2.1.

If you want to use the AmigaGuide help of PlusEd, you must have installed
amigaguide.library and copied the PlusEd.guide in the language you like to
the same directory where PlusEd resides.

The file 'PlusEd.030' is a PlusEd version which is optimized for 68030
processors. It will crash on processors below 68020!
@endnode



@node mainwindow "The main window"

 @{" Project " link project }@{" Edit " link edit }@{" Block " link block }@{" Style " link style }@{" Pen " link pen }@{" Paper " link paper }@{" Mode " link mode }@{" Prefs " link prefs }


 This is the text area. You can see the menus above and the
 gadget box below.


 @{"                                             " link symgads} @{" Style & Text " link styletext}
 @{" Symbol gadgets                              " link symgads} @{" Directions   " link directions}
 @{"                                             " link symgads} @{" Overwrite    " link overwrite}

 @{" Pen                 " link pen} @{" Paper                " link paper} @{" Style        " link style}


@endnode



@node project "Project"

The 'Project' menu holds functions that affect your whole document or PlusEd
itself :

@{b}Clear...@{ub}

Well, that should be clear :-)

@{b}Open...@{ub}

Er... Nothing much to say, either.

@{b}Save@{ub}

Saves the document in a highly opzimized ANSI code with its old name.

@{b}Save as...@{ub}

Saves the document with a new name.

@{b}Special save...@{ub}

Here comes something special : Many BBS programs and so-called ANSI readers
can't handle PlusEd's output, though it is totally standard !
Most programs have problems with switching off the styles separately.
You should then use 'Save with ESC [0m...'. Other programs need their texts
with CR+LF at the end of a line. Save the files for these programs with
'Save with CR+LF...'. And some programs (e.g. the MultiAmnet® BBS software)
require both ('Save with CR+LF and ESC [0m...').

And then there is the menu item 'Save as ASCII...'. This one's for saving
plain ASCII texts without any ANSI sequences.
Warning : If you save an ASCII file, all information about color and style
will be lost !

@{b}About...@{ub}

Gives you information about PlusEd and the registered user.

@{b}Help...@{ub}

PlusEd tries to display the AmigaGuide database PlusEd.guide in PlusEd's
directory. Because of technical reasons no error requester will be shown
if something goes wrong.

@{b}Keymap...@{ub}

Displays a help window with the keyboard shortcuts.

@{b}Quit...@{ub}

Hasta la vista, baby...
@endnode



@node edit "Edit"

@{b}Redraw screen@{ub}

This is useful if PlusEd produces some trash in the text. It has never
happened, but I've added it just to be on the safe side.

@{b}Repeat character@{ub}

Repeats the last character that you've inserted into the text (by typing it
on the keyboard or by selecting it in the @{"symbol gadgets" link symgads}.

@{b}Copy line from above@{ub}

Copies the line above the cursor to the current line. Behaviour depends on
@{"Insert/Overwrite" link overwrite} mode !

@{b}Enter ASCII...@{ub}

Enter an ASCII character by typing in its number.

@{b}Center line@{ub}

Centers the current line.

@{b}Delete line@{ub}

Deletes the current line. Behaviour depends on @{"Insert/Overwrite" link overwrite} mode !

@{b}Insert line@{ub}

Inserts an empty line at the current position.

@{b}Delete to EOL@{ub}

Deletes the current line from the cursor position to the right border.

@{b}Draw box@{ub}
@{b}Draw line@{ub}

Draws a box/line, either with the IBM graphics characters (single & double),
with plain ASCII characters or with a user-defined character ('Select...').
If @{"Overwrite" link overwrite} mode is deactivated, overlapping lines/boxes will be handled
correctly by replacing the characters at the connection points. If you want
wo draw a line/box "above" an other one, you should activate @{"Overwrite" link overwrite}.

@{b}Quickwrite...@{ub}

This is one of the most impressive functions of PlusEd. You can select one
of the fonts in the Quickwrite window and enter a text. This text will then
be inserted at the current cursor position, written in the selected font.
It is even possible to work with Insert mode (turn @{"Overwrite" link overwrite} off).
@endnode



@node block "Block"

This menu holds functions for block operations :

@{b}Mark block@{ub}

After selecting this item, you can mark the block with the left mouse button
or F3. You can use F4 to cancel this operation. F3 and F4 are always used
in PlusEd to select positions and to cancel an operation.

@{b}Mark current page@{ub}

The currently diplayed area is marked.

@{b}Mark entire text@{ub}

The whole text is marked.

@{b}Insert block@{ub}

Inserts the block at the current cursor position. Behaviour depends on
@{"Insert/Overwrite" link overwrite} mode !

@{b}Make 3D@{ub}
@{b}Make shadows@{ub}

Two nice effects. Just trie them out with some huge letters.

@{b}Convert IFF picture...@{ub}

Loads an IFF-ILBM picture, converts it into ANSI text and rescales it into the
current block. In the block modes, the background color will only be used if
you are in @{"Overwrite" link overwrite} mode. Only bitplane 1 will be used for conversion.

The following conversion modes are available:

- IBM full: Uses full character-size blocks only (IBM graphic characters).
- ANSI full: Same as 'IBM full', but uses ANSI highlighting instead
  (font independent, but ANSI colors are required).
- IBM quarters: Same as 'IBM full', but uses quarter-character-size blocks.
- 8 bit: Uses character image matching to find the best character for a
  position in the picture. Characters 32-255 are used. The image matching
  depends on the currently selected font (IBM or Topaz).
- ASCII (7 bit): Same as '8 bit', but uses characters 32-127 only.

@{b}eLiTe TeXt generator@{ub}

Just try it with a piece of text ;)

@{b}Create stereogram@{ub}

Creates a SIRTS (single-image random text stereogram) out of a text area
filled with spaces (back) and other characters (front).

@{b}Draw bevelled box@{ub}

Draws a raised or recessed box. This effect only works with colors according
to the "OS2.0 look and feel".

@{b}Set current colors@{ub}
@{b}Set current styles@{ub}

Uses the current colors/styles for the entire block.

@{b}Exchange colors...@{ub}

Exchanges two colors within the block.

@{b}Replace color...@{ub}

Replaces one color in the block by an other one.

@{b}Replace character...@{ub}

Replaces one character in the block by an other one.
@endnode



@node pen "Selecting a pen"

You can use the 'Pen' menu or the pen gadgets to select a pen. This pen
will be used for text that you are writing and for funtions like "Use the
current colors for the selected block".
@endnode



@node paper "Selecting a paper color"

You can use the 'Paper' menu or the paper gadgets to select a paper color.
This paper color will be used for the background of text that you are
writing and for funtions like "Use the current colors for the selected
block".
@endnode



@node mode "Mode"

This menu holds keyboard shortcuts for the @{"style & text" link styletext}, the @{"directions" link directions}
and the @{"overwrite" link overwrite} gadgets.
@endnode



@node style "Style"

You can select the style (Bold, Italics, Underlined) or reset it (Plain) in
the "Style" menu and style gadgets.
@endnode



@node symgads "Symbol gadgets"

If you click on a symbol gadget, a graphics character will be inserted at
the current cursor position just as if you typed it in via the keyboard.
Have a look at the @{"Preferences" link prefs } to see how you can change the symbol
gadgets yourself.
@endnode



@node styletext "Style & Text"

If the style gadget is activated, all actions which manipulate the text
(writing, QuickWrite, copying,...) will change the colors and styles.

If the text gadget is activated, all actions will change the characters.

All this may sound a bit complicated, but it isn't. Some examples :
- Set 'Text' and clear 'Style' if you want to change some text and don't
  alter the colors and styles, because the text is in a beautiful ANSI
  painting.
- Set 'Style' and clear 'Text' if you want to add colors and styles to
  plain ASCII texts.
You should switch @{"Overwrite" link overwrite} on for both examples.
@endnode



@node directions "Directions"

You can chose the directions for the cursor movement in the 'Mode' menu
and with the direction gadgets.
@endnode



@node overwrite "Overwrite"

If Overwrite is activated, everything which is inserted into the text
(typed in, copied,...) will overwrite the things at the current position.
If Overwrite is not activated (also called 'Insert mode'), the text at
the current cursor position will be moved to the right when new text is
inserted.

You can select Insert/Overwrite in the 'Mode' menu and with the 'Overwrite'
gadget.
@endnode



@node prefs "Preferences"

You can chose between IBM.font and Topaz.font for the text diplay. You can
set the TAB size for TABs in texts which you are loading. You can alter
the colors or chose between several presets.

You can define the @{"symbol gadgets" link symgads} with two methods :

1. Select a character with the cursor, chose 'Define gadget directly...'
   from the Preferences menu and select the gadget for the character.

2. Chose 'Gadget definition...' from the Prefernces menu, select a gadget
   and enter either the ASCII number of the character or the character
   itself.

You can edit the gadget definitions separately for Topaz.font and IBM.font.

If you want to use the preferences until you reboot, you should save them
as 'env:PlusEd.prefs'. If you want to use them for all time, you should also
save them as 'envarc:PlusEd.prefs'.
@endnode



@node registering "Registering PlusEd"

PlusEd is a so-called @{b}Shareware program@{ub}. You may test it, before you buy it.
I.e. in the case of PlusEd : The 'Save' functions are disabled in evaluation
versions, so that you can test everything, but you can't use it normally.
I've included some examples to show you the quality of PlusEd's save
functions.

If you want to get a full version of PlusEd (including 'Save' functions),
you have to register. You will then get a keyfile which will 'unlock' your
version of PlusEd. If you register you also have the possibility to get help
with PlusEd via EMail (see below for EMail addresses).

The registration fee is @{b}DM 30@{ub} or @{b}US$ 20@{ub}. Please send this money together
directly to me (Stefan Zeiger), either in cash or a euro(!)cheque in DM(!),
or transfer the money to Stefan Zeiger, Account #240847285, Sparkasse
Aschaffenburg-Alzenau (Routing code 795-500-00) with the remark 'PlusEd'.
In every case supply your name, your full postal address and any EMail
addresses.

You can always get the latest PlusEd versions and other ! Wizard Works !
programs by sending a disk and US$ 5 directly to me. If you live in Germany,
you may instead send me a disk and a SASE. Disks without enough return-postage
will not be sent back!

If you can be reached via EMail, please add your EMail addresses to all
mail (including normal postal mail) you send to me.


   @{b}Standard Mail@{ub} :     ! Wizard Works !
                       Stefan Zeiger
                       Seligenstädter Weg 24
                       63796 Kahl
                       Germany

           @{b}Voice@{ub} :     +49-6188-2525 (after 6:00PM GMT only!)

           @{b}EMail@{ub} :     s.zeiger@tecmania.tms.mc.org
                       stefan@sweet.rhein-main.de

            @{b}ADSP@{ub} :     stefan@wwsp.adsp.sub.org

         @{b}FidoNet@{ub} :     Stefan Zeiger 2:244/6302.15
@endnode



@node reqtools "ReqTools"

PlusEd is using ReqTools.library. @{b}ReqTools is copyrighted © Nico François.@{ub}
Version 2.2a is distributed with this version of PlusEd. All necessary
files can be found in the directory 'ReqTools'.
@endnode



@node techstuff "Technical stuff"

PlusEd was compiled with SAS/C 6.51. The GUI was created with PowerSource
(the main window) and GadToolsBox (the additional windows and the
menus), both written by Jan van den Baard. Beginning with release 2.1, some
windows were remade with Triton, my own GUI creation system.
@endnode



@node license "License"

                        ! WIZARD WORKS ! PROGRAM LICENSE

                              Version 3, June 1992
                            Written by Stefan Zeiger
                      Copyright © 1992 by ! Wizard Works !


                                    PREAMBLE

        This  is  version  3   of  a   general   license  for   FD  (freely
     distributable) programs by ! Wizard Works !.  This license was written
     because we,  as program authors, have to protect our rights.  We don't
     want to restrict  your freedom  of using this program,  but during the
     last few months it has showed out that the first and second version of
     this license were not strict enough to cover all situations where this
     programn could be "obused" for  various reasons. The main task of this
     license is to forbid  commercial vendors earning  money with our work.
     If you think that the program is, how ever,  worth the money that some
     vendors  ask for it (i.e.  would ask if this license  wouldn't exist),
     then just send some  bucks to the author  to thank him  for developing
     this  program.  If you  know  a vendor  or someone  else  who  is  not
     observing the  terms and conditions  of this license,  please tell the
     author of the program about it.

        You may only use or (re)distribute  a program which is protected by
     this license if you  agree to the following terms  and conditions.

        Mr.  Fred  Fish   is  hereby  exempt  from   these  conditions  for
     distribution of this program in the "AmigaLibDisk" software library.

        You  may  not  use  this  license  for  your  own  programs.  It is
     copyrighted © 1992  by ! Wizard Works !. This  license was  written by
     Stefan Zeiger  of ! Wizard Works ! in 1992.  Everyone is  permitted to
     distribute verbatim copies of this license.

        The author  may put  new  terms and  conditions into  the program's
     manual.  These terms and  conditions will  overwrite the  ones in this
     license, even if this is not explicitely stated in the manual.

        Exceptions to this  license or any other restrictions  which may be
     given by the program's manual require the  prior written permission of
     the author of the program.


        TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  1. This license  applies to any  program  or other work which  contains a
     notice placed by the author saying that it is protected  and/or may be
     distributed  under the terms of the ! Wizard Works ! program  license.
     The term "program"  refers to any  such  program  or other work.  Each
     licensee is addressed as "you".

  2. No profit may be  made with  this program  or any part  of it. You may
     charge a copying  fee, but this fee may not exceed the  media, copying
     and distribution costs.

  3. Nobody  except  for  the author  and/or ! Wizard Works ! may  make any
     profit with this program.

  4. All parts of  the program  must be kept together.  Distribution  in an
     archive made with a commonly used archiver  like LhA, LhArc, Zoo, DMS,
     Zoom or  Shrink is allowed, as  long as  all parts of the  program are
     included in the  archive. If the  program  contains a ".readme"  file,
     this  may  be  distributed  in unarchived  form, but  it must  also be
     included in the archive.

        This program may also be distributed  in a publicly accessable BBS.
     It is allowed to  add some kind of  "readme.BBS" file. But  it must be
     obvious  that  this   text  file  is  not  a  part   of  the  original
     distribution. It  is hereby  declared as  "obvious"  if the  file only
     contains information  about the BBS or if it is clearly  stated in the
     file that it doesn't belong to the original distribution.

        You may  not distribute single  parts of  this program,  except for
     parts   which  are   not  protected  by   this  license,  e.g.  freely
     distributable  libraries  that  are used by  the program and  that are
     included according to their distribution restrictions.

  5. The executable  parts of  the  program  may not  be crunched  with any
     packer program, because many packers are  not freely distributable and
     many users would be unable to decrunch the program.

  6. Any modified  program  may  not be  redistributed. You may  change any
     part  of the  program,  except  for  the  copyright  notice,  for your
     personal needs, if  not stated  otherwise in the program's manual, but
     you may not redistribute your modified version.  Neither may you claim
     authorship of the program.

        As an exception to the above  it is allowed to  change the "Default
     Tools"  of files  that  require  an  external  "player"  routine, like
     pictures,  sounds,  musics  or texts,  but it  must  be  stated  in an
     additional file,  that the  default tool has been changed  and what it
     was before.

        Furthermore may you change the  colors of icons except for programs
     with  "OS 2.0 style"  (see section 12 about this).  This must  also be
     stated in an extra file.

  7. This license  must be included in  all distributions.  If it isn't yet
     included in the  main directory of the program,  but instead somewhere
     else on  a disk which contains  this program  and probably  some other
     programs which  are protected by this  license, you  have to  copy the
     license document into a file named  "License" in the main directory of
     the program, in order to redistribute the program separately.

  8. The  distribution of  this  program  in  FD  program  series  or  disk
     magazines is allowed, as long as the per-disk fee doesn't exceed US$ 6
     or an equivalent in any other currency.

  9. This condition is  only for Germany, Austria  and Switzerland : Dieses
     Programm darf  nicht von  Mitgliedern der  "Schwarzen Liste",  die vom
     Diskettenmagazin "Amiga Juice" herausgegeben wird, kopiert werden.

 10. A program that is protected by  this license is copyrighted (© year of
     first  distribution  and  future)  by ! Wizard Works ! or  a member of
     ! Wizard Works !. All rights are reserved.

 11. Neither  this  program  nor  any part  of  it  may  be  included  in a
     commercial product without the prior written permission of the author.

 12. If this program  uses the "Amiga OS 2.0"  design, you have  to use the
     appropriate colors, if  you distribute this  program on a self-booting
     disk. These  colors are : "0" medium bright, "1" black, "2" white, "3"
     bright color. Furthermore should  you take care about the window sizes
     and icon positions so that everything looks good on a standard OS 2.04
     system. Nobody is  forced to to this, because the new  Amiga OS 2.0 or
     higher is not yet available for  all Amiga computers. But at least the
     colors must be correct.

 13. If this license is used  for a "Shareware" program, you have the right
     to test the program without paying for it. But if you like the program
     and/or use it regulary, you have the moral and legal obligation to pay
     the shareware  fee. Please  send your  shareware  fee directly  to the
     author.  The author's  address  should  be stated  at the  end of  the
     program's manual.


                                   DISCLAIMER

 14. NEITHER  THE  AUTHOR  NOR ! WIZARD WORKS ! GIVE  ANY WARRANTY  FOR THE
     PROGRAM,  TO THE  EXTENT  PERMITTED BY  APPLICABLE  LAW.  EXCEPT  WHEN
     OTHERWISE STATED IN WRITING THE AUTHOR AND/OR COPYRIGHT HOLDERS AND/OR
     OTHER PARTIES  PROVIDE THE  PROGRAM "AS IS"  WITHOUT  WARRANTY  OF ANY
     KIND, EITHER EXPRESSED OR  IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
     IMPLIED  WARRANTIES OF  MERCHANTABILITY AND  FITNESS FOR  A PARTICULAR
     PURPOSE. THE  ENTIRE  RISK AS TO  THE QUALITY  AND PERFORMANCE  OF THE
     PROGRAM IS WITH YOU.  SHOULD THE PROGRAM  PROVE DEFECTIVE,  YOU ASSUME
     THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

        IN NO  EVENT  UNLESS  REQUIRED BY  APPLICABLE LAW  OR AGREED  TO IN
     WRITING WILL ANY AUTHOR  OR COPYRIGHT HOLDER,  OR ANY OTHER  PARTY WHO
     MAY  MODIFY AND/OR  REDISTRIBUTE  THE PROGRAM  AS PERMITTED  ABOVE, BE
     LIABLE TO YOU FOR DAMAGES, INCLUDING  ANY GENERAL, SPECIAL, INCIDENTAL
     OR CONSEQUENTIAL  DAMAGES ARISING OUT OF  THE USE OR  INABILITY TO USE
     THE PROGRAM  (INCLUDING BUT NOT LIMITED TO LOSS OF DATA  OR DATA BEING
     RENDERED INACCURATE OR LOSSES  SUSTAINED BY  YOU OR THIRD PARTIES OR A
     FAILURE OF THE  PROGRAM TO OPERATE WITH  ANY OTHER PROGRAMS),  EVEN IF
     SUCH  AUTHOR  OR  HOLDER  OR  OTHER  PARTY  HAS BEEN  ADVISED  OF  THE
     POSSIBILITY OF SUCH DAMAGES.


                        END OF TERMS AND CONDITIONS
@endnode
