User's guide

1) Legal

This program is PostCardware. No money is asked to use this software.
Its copy is legal and stronly advised.

Disclaimer : I am not responsible of the use of this program. Use this at
your own risk, specialy you're responsible upon files manipulation you'll
make with Joe.

If this program pleases you, I invite you to send me a postcard or an e-mail.
This will describe the bugs you have found, options you would like to have,
an angry or a greeting message. My address :

  Pierre TONTHAT
  35, Avenue Lacassagne
  F-69003 Lyon
  nef@mygale.org


2) Installation

Joe needs 1 Mb memory to run. If you want Joe and the browser at the same
time in memory, you'll need a minimum of 2 Mb or you'll have to quit Joe to
run the browser.
A hard disk is advised. If not, a second floppy disk should be usefull.

a. Install Joe eveywhere on your disk.
The new JOE.PRG and JOE.RSC must be together. You'll have to delete the old
JOE.RSC evenif you have customized it.
NB : A JOE_C.RSC with color icons exists recently, located in the GOODIES
repertory. Rename it as JOE.RSC and put it besides JOE.PRG. This color RSC
works only with AES equal or greater than 3.40 (Falcon TOS or every Atari
under MagiC or NAES environement).

b. Launch JOE.PRG and determine the paths and the preferences in the
"Options" menu. Save the configuration.
The lines number in the preferences is important : it determines Joe memory
consommation.
Choose a good value (3000 lines (width 128 caracters) is a good compromize).
It is counselled not to load huge files. Ethicaly thinking, an HTML file
should not be over 32 Kb to avoid long HTTP downloading.
You can have several configuration, but JOE.INF is always loaded at launching.
Determine also the repertory containing the modules.

c. Install OLGA (save the buggy 1.50 version) and BubbleGEM in the AUTO
folder of your multitasking OS.
Edit the OLGA.INF file and write at [applications] location,
JOE=path+name of JOE.PRG
JOE searchs OLGA and BubbleGEM presence at launching.


3) Generalities

Joe is a text editor specialized for HTML pages creation and a shell for an
HTML browser. You have som utilities and facilities such as text macros,
automatic conversion of special caracters, tag colors...
Modules can be launched from 1.40 version and can generate (for example) tags
easier than writting them directly. 

Icons description (left to right)

- Load an HTML file or Atari ASCII text (LF+CR at line end)
- Insert an HTML file or Atari ASCII text, from a directory defined
in the paths (Library)
- Save text in Atari ASCII text format (or the block if it exists)
- Print the whole text or the block. Be carefull if you are under
Falcon TOS : printing will work correctly with a patch (TOS bug).
- Delete the text or the block
- Search : a string text, ASCII caracters greater than 127, Bad relatives
links
- Utilities : Replace, Special caracters Conversions, Destroy the tags
Extract links
- Select the top or the bottom of the block
- Insert text from the clipboard
- Copy block in clipboard
- Move block to clipboard
- Launch browser. Automatic text saving before launch is done if
you declared it in the preferences.
-Drag and Drop, for the whole text or the block. Exchanges with
others applications only work in multitasking mode.
The block can be dragged to an editable field object : the first line
of the block will be inserted.


4) Mouse use

- Left clic

Icon selection or formulars manipulation
* On the text : locate the text cursor
* On the text + Control : select top of the block
* On the text + Alternate : select bottom of the block
* On the text + Left Shift : select the line as block

- Double left clic

* On the text : apparition of the fileselector, which permits
the insertion of a filename in the text (with consideration of relatives paths).
* On an editable field object of the window "Macros de texte" : apparition of
a fileselector which permits to link the macro to an external file *.HTM or
*.STG of the library

- Left clic (holding) + right clic, hold the buttons pressure

Apparition of a pop-up menu containing spacial caracters (ASCII>127).
When a caracter is choosen, stop pressure on the right button. There's next
an insertion (and automatic conversion (if you have choosen the option in
"Miscellaneous") of the caracter at the text cursor location.

- Right clic

* On the icons tool bar, the tag menu or the text macros window : activation
of BubbleGEM.
Activation is automatic if you have select the Deamon option in BubbleGEM
preferences.
* On the text : activation of the modules launching pop-up.


5) Special keys use

Everywhere :

F1 : Load a preferences file (*.INF)
Shift+F1 : Save the preferences (*.INF)
F2 : Determine paths
F3 : Miscellaneous
F4 : Text macros

F5 : Open the editing window
F6 : Full screen for the browser and the editor windows
F7 : Screenband windowing for Joe and browser

F9 : Activation of browser window or launch the browser
F10 : Launch the browser alone or with the Joe edited text
(Automatic save if declared in the preferences)

Control+Q : Quit
Control+U : Close the window
Control+W : Window full screen (or old size)
Control+G : Garbage collection in Joe memory


HTML edition window :

Control+L : Load
Control+M : Merge
Control+S : Save
Control+P : Print (GFA Llist therefore be carefull in Falcon TOS bug)
Control+Backspace : delete the text or the block
Control+C : Search
Control+V : Keep searching
Control+R : Replace
Control+H : Select the top of the block
Control+B : Select the bottom of the block
Control+I : Insert from clipboard
Control+J : Copy block to clipboard
Control+K : Move block to clipboard
Control+A : Launch the browser (with or without saving, see preferences)

Insert : Insert a new line (GFA editor way)
Control+Delete : Delete the line (also GFA editor way)

Alternate+valeur ASCII: Insert every ASCII caracter
(you need CKBD under MagiC)

Help : Activation of the tags menu
Arrows : Select item
Left shift + arrows : Top, bottom, ending right or left item selection
Space or Return : Valid = Insert item in the text
Escape : Cancel


Text macros window :

Control+arrows : Change key
Control+P : Print entire list of macros
Control+L : Load a text macros (*.MAC)
Control+L : Save the text macros (*.MAC)


6) Text macros

There are two ways inserting text macros :
- with the tags menu in the editing window. mounted with the left clic mouse
or Help key.
- with short-cuts always including Alernate and (A to Z) keys.

You can modify these macros as you wish :
- modify the JOE.RSC at the third tree (tags menu) with a ressource editor
like WERCS, INTERFACE, or RSC3. Joe is coded to accept an modified tags menu.
You can add, delete, modify the items (G_STRING) or add menus (G_TITLE).
I don't advise these manipulations to neophytes.
IMPORTANT : a menu must be small not to create drawing bugs.
It must not take over the 640*400 screen on Falcon singleTOS (ie bugs).
You must Sort the items and the menu if you dont' want to have surprises
when using the menu with keys.
- Configure the text macros keys, directly under Joe, in the window
"Text macros". You can change text macros at every moment.

Some caracters of the text macro string are reserved :

"|" : same as "Return"
"~" : locates the text cursor after the macro insertion
"#" at first : means to load a file located in the library.
If the extension is *.HTM, the file is inserted in the text line per line.
If the extension is *.STG, the file is inserted as a text macro.


7) Modules

Joe handles since 1.40 version externals modules and a custom protocol which
permits text exchanges.

To be launched under Joe and appear in the pop-up modules (right clic
on text), these programs must :

- have the *.PRG extension
- be in a module directory defined in the options
- be besides a text file with the same name of the module but but the
*.JXM extension .
Module activation is managed in Miscellaneous in Joe program.

For more details, consult the programmer's guide