@database Mentat.guide
@version $VER: Mentat.guide 0.7 (05.01.2002)

@master Mentat.guide

@node main
@title "Mentat 0.7 English2English Dictionary"

@{jcenter}@{fg highlight}@{b}Mentat 0.7@{UB} - English2English Dictionary@{fg text}

© 2000-2002 by Adrian (Sauron) Siemieniak.



@{" Introduction          " link INTRODUCTION}
@{" Requirements          " link REQUIREMENTS}
@{" Disclaimer            " link DISCLAIMER}
@{" Distribution          " link DISTRIBUTION}

@{" Installation          " link INSTALLATION}
@{" Usage                 " link USAGE}
@{" ARexx                 " link AREXX}
@{" Registration          " link REGISTRATION}

@{" History               " link HISTORY}
@{" Future                " link FUTURE}
@{" Author                " link AUTHOR}

@{jleft}

@endnode


----->> INTRODUCTION
@node INTRODUCTION Mentat Author informations
@smartwrap
@{jcenter}
@{fg highlight}Introduction@{fg text}



@{jleft}
    Mentat is an english to english dictionary based on Longman Natural English
Dictionary. It's main purpose is to help people translate large, english
texts (books, stories etc). This type of dictionares has two advantages (unless
two) - first of all it can be used by everyone in Poland, Germany, Brazil and
so on. Secondly it's the only kind of such a publication that allows to translate
some words from spoken english.


    Full version of Mentat has a bit less then 60 000 words. You can find
every word in seconds, copy it description to editor, find related words,
find whole group of words by giving their base name etc.

@endnode


----->> REQUIREMENTS
@node REQUIREMENTS Mentat Requirements
@{jcenter}@{fg highlight}Requirements@{fg text}
@{jleft}

   @{B}·@{UB} MUI 3.8
   @{B}·@{UB} mc68020
   @{B}·@{UB} NList MUI class (included)
   @{B}·@{UB} Textinput MUI class (included)
   @{B}·@{UB} about 2MB of RAM to work
	Mentat can work with 200KB of memory, but it requires about
	90KB for every index (26 indexes in full dictionary), if
	somebody will request I can reduce usage to about 500KB but
	it will make Mentat REALY slow.
   @{B}·@{UB} 24MB on HardDisk or CD


@endnode



----->> DISCLAIMER
@node DISCLAIMER Mentat Disclaimer
@smartwrap
@{jcenter}
@{fg highlight}Disclaimer@{fg text}

@{jleft}


This  program  is  provided  "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 results and performance of this program is assumed by you.


Should the program prove defective, you alone assume the entire cost of all
necessary  servicing,  repair,  or  correction.   Further,  the  author  of
Mentat  neither  warrants,  guarantees,  or  makes  any representations
regarding the use of, or the results of the use of, the program in terms of
corrections, accuracy, reliability, currentness, or otherwise; and you rely
on the program and results solely at your own risk.



@endnode




----->> DISTRIBUTION
@node DISTRIBUTION Mentat Distribution
@smartwrap
@{jcenter}
@{fg highlight}Distribution@{fg text}

@{jleft}


This demo archive of @{fg shine}Mentat@{fg text} can be distributed without any other
conditions on Aminet and Aminet CDs.


All  other  CD/DVD  distributions  can be done only if I receive UNLESS
information about it (or ;) one copy of it).


@{fg shine}Mentat@{fg text} can't be placed on Internet without my permission (and it
will be only granted for native Mentat mirrors or program libraries).


This archive can be placed on BBS and other networks as long as
it contains every part of oryginal one.


@{b}You may NOT distribute registered version of Mentat.@{ub} ;)



@endnode



----->> AREXX
@node AREXX Mentat ARexx interface
@smartwrap
@{jcenter}
@{fg highlight}ARexx@{fg text}

@{jleft}

	Since Mentat is an MUI application it has 5 builtin ARexx commands QUIT,
HIDE, SHOW, INFO and HELP - this is quite obvious so lets skip to Mentat
native instructions.


@{B}FindWord Word/A@{UB} - mentat will search in it's dictionary for word "Word"
and return 1 - if such a word exists, 0 - if not.


@{B}ShowWord Word/A@{UB} - quite similar to previouse command but if Mentat will
find "Word" it will be shown in Mentat main window (and 1 - means there
is such a word, 0 - not)


@{B}NextWord@{UB} - Mentat will go to next word in it's dictionary (just like right
arrow on Mentat window)


@{B}PrevWord@{UB} - ehmm ;) yes your'r right, it's opposite command to NextWord - just
like left arrow is opposite to right one...



@{I}Now few words about Mentat ARexx scripts:@{UI}


CygnusED scripts: you should put those scripts under F-keys in menu Special->
Dos/Arexx interface-> Install command.


@{B}Mentat_CheckWord.ced@{UB} - this script will check if
word under cursor exists in Mentat dictionary - it's kind of spell checker.


@{B}Mentat_FindWord.ced@{UB} - just like before but result is shown in Mentat
main window.


@{B}Mentat_NextWord.ced@{UB} - you can control Mentat next/previouse word
from CED - main purpose of it is situation where you will use FindWord.ced
on for example "start" and you want to see "start2" in Mentat window.



@{B}Mentat_FindWord.awebrx@{UB} - it's AWeb script that try to translate word
marked by mouse and show it in Mentat window. Use menu Settings-> GUI settings->
Menu to add script to AWeb menu (you can also set there hot key).



@{B}Mentat_FindWord.arexx@{UB} - this script works exactly the same like one
before (for AWeb) but requires "ClipRead" tool (you can find it in Tools/ dir).
You have to put ClipRead somewhere on path (bestly to C: dir). I'v created
it to use with IBrowse, but it will probably work quite good with Voyager
and plain RX command from shell. This script reads string from Clipboard (unit 0)
and try to show it in Mentat window. Since IBrowse after marking a piece of text
with mouse copy it to Clipboard you need only to run this script after that
action to translate choosen word. Script will also STRIP spaces before and after
copied word.




@{jleft}

@endnode



----->> INSTALLATION
@node INSTALLATION Mentat Installation procedure
@smartwrap
@{jcenter}
@{fg highlight}Installation@{fg text}

@{jleft}

    Whole installation process is more then simple. Just unarchive (lha or lzx)
file to directory where you would like to have Mentat installed (you don't have
to create directory). That's all. You only have to remember that Mentat will
search for data files in "Mentat:" directory, so you have to create assign
for it in startup-sequence/user-startup by adding line:


C:Assign Mentat: <path where mentat dir is>


or if you have MCP in LateAssign lister (quite nice tool) ;)

Everything about ARexx scripts and command can be found
@{"here" link AREXX}


@endnode


----->> USAGE
@node USAGE Mentat Usage
@smartwrap
@{jcenter}
@{fg highlight}Usage@{fg text}


@{jleft}

 @{" Main Window   " link USAGEMW} - is the essential part of program. Here you can
operate on dictionary, find words, walk thrue dictionary etc. Whole look of it
is dependent of user MUI preferences.


 @{" Search Window " link USAGESW} - here you can search in dictionary for groups
of words with the same core. Window can be opened from Main Menu or by useing
@{fg shine}*@{fg text} in Text input area of Main Window.


 @{" Main Menu     " link USAGEMM} - mostly used for preferences, help and informations.
You can also open Search Window from here.


@endnode




----->> USAGE - Main Window
@node USAGEMW Mentat Usage of Main Window
@smartwrap
@{jcenter}
@{fg highlight}Usage of Main Window@{fg text}


@{" [^][                               ][^] [<][>] " link Mainbar.iff}

@{jleft}


@{b}@{u}Main List View@{uu}@{ub}

Huge part of the main window is used by listview with description
of founded  word. You can move it with scroller or cursor arrows
(even when typing new word). Text can be copied to clipboard (use
mouse to mark region) for further use.


@{b}@{u}Related words@{uu}@{ub}

First button on left is used to show listview with related words
to founded one. This words are not founded by program but are
marked to be related in database of current word.


@{b}@{u}Text input@{uu}@{ub}

Here you can write word to be founded in dictionary. If you want
to get second occure of the word in database put '2' on the end, like
@{fg shine}'about2'@{fg text} (of course you can use 3,4,5 etc.) If
you want to find all words beginning with known core write 'core*'
for example @{fg shine}'anne*'@{fg text}. This will open new
window (Search Window) where you can do more searches or simply
select right word from listed words.


@{b}@{u}Founded words@{uu}@{ub}

Pressing this button you will bring new listview with all previously
founded words (only written in Text Input field) - it's a kind of
history to simply get back to already translated words.


@{b}@{u}Prev/Next word@{uu}@{ub}

Those two buttons allow to walk thrue dictionary going to next or
previouse word to current one.


@endnode




----->> USAGE - Search Window
@node USAGESW Mentat Usage of Search Window
@smartwrap
@{jcenter}
@{fg highlight}Usage of Search Window@{fg text}


@{jleft}

In Search Window you can see only two gadgets, Text input and Listview.


@{b}@{u}Text input@{uu}@{ub}

You can write here a core of some words (without @{fg shine}*@{fg text}) to be founded
in dictionary. Result of search is placed in Listview below.


@{b}@{u}Listview@{uu}@{ub}

Here you can see search results. You can get description of a word by double clicking
on it or marking with up/down arrows (on keyboard) and pressing enter. Window will
not be closed after it.

@endnode



----->> USAGE - Main Menu
@node USAGEMM Mentat Usage of Main Menu
@smartwrap
@{jcenter}
@{fg highlight}Usage of Main Menu@{fg text}


@{jleft}

Like for now there is nothing to explain! @{fg shine};)@{fg text}


@endnode




----->> REGISTRATION
@node REGISTRATION Mentat Registration
@smartwrap
@{jcenter}
@{fg highlight}Registration@{fg text}


@{jleft}

@{fg shine}Mentat@{fg text} is Shareware, so it means you have
to register it if you use Mentat for more then 20 days.

You can register Mentat (with all future updates) by sending 10 EURO on
my account (or equivalent of 10 EURO in dollars, pounds or german marks
directly to me) and all required data by email.


My account:

	PKO BP I-O Wroclaw, Poland

	94 10205226 415790478


My adress:

	Adrian Siemieniak

	ul.Litewska 24/9

	51-354 Wroclaw

	Poland


As soon as I get required data and money you will receive personalized
key-number. You may not spread that key on net to friends etc! All
published keys will be deactivated.

With that KEY you can download rest of dictionary from Mentat webpage.
(this KEY will be valid to download all future releases and upgrades)

Send all required to registration data on e-mail
@{fg shine}registration@mentat.i.pl@{fg text}

Full name :

Adress :

Email (where I should send keyfile) :

Your Amiga configuration :



All questions about registration can be send to:
@{B}sauron@mentat.i.pl@{UB} with subject beginning with Mentat:


If you are an author of shareware/commercial programs we can swap
(long live the Fighters!) ;)


@endnode



----->> FUTURE
@node FUTURE Mentat Future
@{jcenter}@{fg highlight}Future of Mentat@{fg text}

@{jleft}
	- bug fixes
	- more preferences
	- Printing
	- Program to add new words

Later...
	- Native dictionaries


@endnode




----->> AUTHOR
@node AUTHOR Mentat Author informations
@smartwrap
@{jcenter}
@{fg highlight}Author@{fg text}

@{jleft}


    If you have any suggestions, ideas etc. please mail me
@{fg highlight}sauron@mentat.i.pl@{fg text} with subject beginning with
@{B}Mentat:@{UB}


Mentat Web Page is @{fg highlight}@{U}http://mentat.i.pl@{UU}@{fg text}, you can get there all
new releases, informations and help.



@{jcenter}
@{U}My snail mail is@{UU}:

Adrian Siemieniak

ul.Litewska 24/9

51-354 Wroclaw

Poland

@{jleft}


@endnode



----->> HISTORY
@node HISTORY Mentat History
@{jcenter}@{fg highlight}History of Mentat@{fg text}

@{jleft}
Version - 0.7 (5 Jan 2002)
	[FIX] Some fixes of old/new bugs
	[NEW] Library updates (and code update to fit)
	[NEW] New WWW page, email etc.

Version - 0.6 (17 Oct 2001)
	[NEW] ARexx interface (4 commands)
	[NEW] ARexx scripts to connect Mentat with CygnusED, AWeb, IBrowse
	[NEW] Spanish and Czech localization
	[NEW] Visual improvements
	[FIX] like always there are some
	[FIX] some tiny opimizations

Version - 0.5.2 (6 Jul 2000)
	[NEW] search options (in main window and in new Search Window)
	[NEW] localization (like for now only polish one)
	[NEW] documentation (english and polish one)
	[NEW] new data format
	[NEW] add counter gadget in search window (with count of founded words)
	[FIX] plenty of fixes in code
	[FIX] searching it's about 60% faster!
	[FIX] in search window - it was eating all memory until the big	crush
		of a system (sometimes ;) )

Version - 0.4 (26 May 2000)
	[NEW] index file and data file splitted in 26 smaller files
		(works much faster on slow machines)
	[FIX] NEXT/PREV buttons works correctly (but still don't work ok
		on beginnining/end of dictionary)
	[FIX] memory allocation problem fixed - Mentat 0.3 because of it
		crashed after few searched words
	[NEW] working preferences (with possiblity of changing display colors)
	[NEW] now Mentat use NFloattext.mcc (from NList package)
	[NEW] keys arrow up/down are now always connected to main listview
	[NEW] with Textinput version text gadget is always active

Version - 0.3 (6 May 2000)
	[FIX] few enforcer hits fixed
	[NEW] new Related Words listview
	[FIX] menu problem fixed
	[NEW] now you can search words like "command2" (2 means - find second
		meaning of word "command")
	[NEW] now you can walk thrue dictionary with Next/Prev buttons

@endnode


