@DATABASE Word Mania
@(C) Copyright © Vex/Shoah 1996
@$VER: WordMania.Guide V1.2 (7 September 1996)
@AUTHOR VEX
@REM Creation 	1.0	(19 Aug 96)	- Basic text.
@REM            1.1	(29 Aug 96)	- Styled and formatted.
@REM		1.2	(07 Sep 96)	- Final checks and dedication.
@WIDTH 76
@SMARTWRAP
@INDEX INDEXNODE
@NODE MAIN "WordMania V1.0"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

@{" Introduction        " LINK INTRO} - What this program does.
@{" Distribution        " LINK DISTRIBUTION} - Legal stuff.
@{" System requirements " LINK SYSREQ} - What you need to use it.
@{" How to use          " LINK HOWTOUSE} - How to use. (What do you expect?)
@{" Programs gadgets    " LINK GADGETS} - An explaination of the gadgets and window display.
@{" Programs menus      " LINK MENUS} - An explaination of the menus.
@{" Patterns            " LINK PATTERNS} - The programs pattern matching capablities.
@{" Examples            " LINK EXAMPLES} - Some examples of how to use this program.
@{" Dictionary format   " LINK DICFORMAT} - The types of dictionaries this program uses.
@{" Program history     " LINK HISTORY} - Previous incarnations.
@{" Future Updates      " LINK FUTURE} - What the next version will contain.
@{" Credits             " LINK CREDITS} - Who wrote this damn thing.
@{" SHOAH               " LINK "SHOAH.Guide/MAIN"} - The best in top quality software.

@{BODY}
Please  note,  this  guide  has been designed for V40 AmigaGuide.Library and
datatypes.

@ENDNODE
@NODE INTRO "Introduction"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}
@{BODY}

This program is designed to find anagrams of words and to performing pattern
matching functions on a dictionary of words.
@{PAR}
@{CODE}
Features include :-

	@{FG FILL}o @{FG HIGHLIGHT}Anagram searching.
	@{FG FILL}o @{FG HIGHLIGHT}Full pattern matching.
	@{FG FILL}o @{FG HIGHLIGHT}Fast dictionary searching.
	@{FG FILL}o @{FG HIGHLIGHT}Lots of criteria options.
	@{FG FILL}o @{FG HIGHLIGHT}All lists can be saved.
	@{FG FILL}o @{FG HIGHLIGHT}Full user preferences.
	@{FG FILL}o @{FG HIGHLIGHT}ASCII dictionary support.@{FG TEXT}
	
@{BODY}
For  example,  giving  the program @{FG SHINE}"WordMania"@{FG TEXT} as the search string, it will
produce the following list of anagrams...
@{PAR}@{CODE}@{FG FILL}
	Adorn   Dam    Draw    Marina Now    Raw     Warm
	Aid     Dam    Drownn  Maw    Oar    Rid     Warn
	Aim     Darn   Id      Mid    On     Rim     Win
	Air     Dawn   In      Mind   Onward Rind    Wind
	Airma   Dimn   Inroad  Minor  Or     Road    Woad
	Am      Din    Inward  Moan   Ordain Roam    Woman
	Amain   Dina   Ionr    Morn   Own    Roan    Won
	Amid    Do     Iron    Mow    Radio  Rod     Word
	An      Doma   Main    Nadir  Radon  Row     Worm
	And     Don    Mad     Naiad  Raid   Wad     Worn  
	Aria    Dona   Maid    Nard   Rain   Wadi
	Arid    Dorm   Main    No     Ram    Wain
	Arm     Down   Man     Nod    Ran    Wan
	Aroma   Drai   Manian  Nomad  Rand   Wand
	Award   Dram   Manor   Nor    Random War    
	Awn     Dram   Mara    Norm   Rani   Ward


@{BODY}@{FG TEXT}
Or  giving  it the pattern @{FG SHINE}"*rian"@{FG TEXT} (meaning all words ending in @{FG SHINE}'rian'@{FG TEXT}) will
give this output...
@{PAR}@{CODE}@{FG FILL}
	Abecedarian         Latitudinarian      Stentorian
	Agrarian            Libertarian         Totalitarian
	Antiquarian         Librarian           Utilitarian
	Authoritarian       Nonagenarian        Valedictorian
	Barbarian           Octogenarian        Valetudinarian
	Centenarian         Parliamentarian     Vegetarian
	Disciplinarian      Pedestrian          Veterinarian
	Equestrian          Proletarian         Vulgarian     
	Historian           Riparian
	Humanitarian        Sectarian      
@{BODY}@{FG TEXT}


The  program  can  also be used to limit the search engine, by searching for
words within particular length limits, and by looking for words with certain
letters in.


WordMania  can  be  used  to  solve many word puzzles, such as the @{FG HIGHLIGHT}"SUNDIAL"@{FG TEXT}
puzzle  that occurs in @{FG HIGHLIGHT}"The Sun"@{FG TEXT} everyday.  WordMania can also act as an aid
to  solving  many other word puzzles, such as normal crosswords and clueless
crosswords,  and  if you run it on a fast amiga you could use it to cheat on
the  T.V.   program  @{FG HIGHLIGHT}"Countdown"@{FG TEXT}  (Although  how  you  go about getting your
computer  into  the  T.V.   studios  is something that isn't covered in this
document :)

@ENDNODE
@NODE DISTRIBUTION "Disclaimer & Distribution"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

@{JCENTER}@{FG HIGHLIGHT}@{B}DISCLAIMER@{UB}

@{FG TEXT}@{BODY}@{JLEFT}The  entire  risk  as to the quality and performance of this program is with
you.   The author and SHOAH assume no responsibility or liability whatsoever
with  respect to your use or inability to use this software.  The author and
SHOAH  is  not  responsible  for  any  loss  of data, damages to software or
hardware  that  may  result  directly  or  indirectly  from  the use of this
program.   The  author and/or SHOAH reserve the right to make changes to the
software and/or documentation without prior notice.


@{JCENTER}@{FG HIGHLIGHT}@{B}DISTRIBUTION@{UB}


@{BODY}@{FG TEXT}@{JLEFT}This  program  and  documentation  is  Copyright © September 1996 Vex/Shoah.
This  program  is  freeware, it may be freely distributed for non-commercial
purposes only.


A  charge  of  NO  MORE  than  two  (2)  UK  pounds  may  be charged for the
distrubution  of  these  files  (  If  you  have paid more, then please send
details to the Author ).


If  you  wish  to place this program on coverdisks or CD-ROMs or to use this
within a commercial product, then you must contact @{" me " LINK CREDITS} before hand. This is
to  ensure  that you have the most recent and upto date version.  I may also
ask  for a copy of the magazine/CD-ROM or Commercial product.  Permission is
hereby  granted for this program and related files to be archived and placed
on Aminet (including Aminet CD-ROMs).

@ENDNODE
@NODE SYSREQ "System Requirements"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

WordMania  is completely system friendly (naturally :) and should run on any
machine  with  Workbench  and  Kickstart  3.0.   It  has  not been tested on
Workbench 2.0, but it might work.

The program needs the following standard system libraries...

@{FG SHINE}Gadtools.library
ASL.Library@{FG TEXT}

@ENDNODE
@NODE HOWTOUSE "How to use the program"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

@{BODY}WordMania  is  very  simple  to use.  Just run it from Workbench or the CLI.
The program will load and you will be presented with it's main window.  From
here  you  can either enter a string to search for, open the criteria window
for  a  more specific search or open the preference window to adjust the way
the program works.


The Criteria Window runs asynchronously to the main window, meaning that you
can keep it's window open and still use the main window.


The  Preference Window will disable the Main and Criteria windows when it is
opened.


The  program  uses  a dictionary of words as the basis for all it's searchs,
the  format  of  these dictionaries is discussed in the @{" dictionary formats " LINK DICFORMAT}
section  (Spooky,  eh?).   This  dictionary  can either be held in memory or
accessed  from  disk.   When  performing  searchs  the program can utilise a
method  of  fast  section  skipping.  This involves skipping sections of the
dictionary that it doesn't need to look in.  However before this can be used
the  program  needs  to  scan the whole of the dictionary file, this is done
either  by  @{" PreScaning " LINK PFG_PRESCAN}  the  file  or  during  the first full search.  The
information  from  these  scans  is  saved  in the preferences file, so this
scanning only needs to be done when you change/alter the dictionary file.


@ENDNODE
@NODE GADGETS "Program Gadgets"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

The main window contains the following gadgets and displays...

@{" Search String   " LINK MWG_STRING}	@{" Display         " LINK MWG_DISPLAY}	@{" SEARCH!         " LINK MWG_SEARCH}
@{" Criteria        " LINK MWG_CRITERIA}	@{" Preferences     " LINK MWG_PREFS}	@{" Clear List      " LINK MWG_CLEARLIST}
@{" Search Results  " LINK MWG_RESULTS}	@{" Total Matchs    " LINK MWG_TOTAL}	@{" Exact Matchs    " LINK MWG_EXACT}
@{" Criteria Matchs " LINK MWG_CRITE}	@{" Words Searched  " LINK MWG_WORDS}


The search criteria window contains these gadgets...

@{" Word length greater than " LINK SCG_GREATER}	@{" ...and less than         " LINK SCG_LESS}
@{" MUST have these letters  " LINK SCG_MUST}	@{" In sequence?             " LINK SCG_INSEQ}
@{" Start search in section  " LINK SCG_START}	@{" ...and end in section    " LINK SCG_END}
@{" Only match criteria      " LINK SCG_ONLYMATCH}	@{" Clear All Criteria       " LINK SCG_CLEAR}


The preference window contains these options...

@{" Dictionary File            " LINK PFG_DICTFILE}	@{" Display results as         " LINK PFG_DISPLAYAS}
@{" Load dictionary to memory? " LINK PFG_LOADDICT}	@{" Case sensitive searchs?    " LINK PFG_CASESENSE}
@{" Save preferences on exit?  " LINK PFG_SAVEEXIT}	@{" Include criteria in prefs? " LINK PFG_INCCRIT}
@{" Include length in display? " LINK PFG_INCLEN}	@{" Fast progress display?     " LINK PFG_FASTDIS}
@{" Fast section skip?         " LINK PFG_FASTSKIP}	@{" Pre-scan dictionary file?  " LINK PFG_PRESCAN}
@{" Save                       " LINK PFG_SAVE}	@{" Use                        " LINK PFG_USE}
@{" Cancel                     " LINK PFG_CANCEL}

@ENDNODE
@NODE MENUS "Program Menus"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

The following menu options are available...

@{FG HIGHLIGHT}'Save All Matchs'@{FG TEXT}
This will save a list containing all the matchs that were found.

@{FG HIGHLIGHT}'Save Exact Matchs'@{FG TEXT}
This  will  save  only  those matchs that have an equal length to the search
string.

@{FG HIGHLIGHT}'Save Criteria Matchs'@{FG TEXT}
This saves the matchs that fit within the search criteria.

@{FG HIGHLIGHT}'About'@{FG TEXT}
Display a requester with information about the program and author.

@{FG HIGHLIGHT}'Quit'@{FG TEXT}
Terminates the program.

@ENDNODE
@NODE PATTERNS "Pattern Matching"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

@{BODY}The  program  uses the standard dos.library pattern matching routines so all
the  patterns  are  the  same  as  the  file  patterns that can be used with
programs like 'copy', 'dir' and in ASL file requesters.


@{CODE}WordMaina can except all of the following patterns in the search string.


	@{FG SHINE}?	@{FG TEXT}Matches a single character.
	@{FG SHINE}#	@{FG TEXT}Matches the following expression 0 or more times.
	@{FG SHINE}(ab|cd)	@{FG TEXT}Matches any one of the items seperated by '|'.
	@{FG SHINE}~	@{FG TEXT}Negates the following expression.  It matches all strings
		that do not match the expression (aka ~(foo) matches all
		strings that are not exactly "foo").
	@{FG SHINE}[abc]	@{FG TEXT}Character class: matches any of the characters in the class.
	@{FG SHINE}[~bc]	@{FG TEXT}Character class: matches any of the characters not in the
		class.
	@{FG SHINE}a-z	@{FG TEXT}Character range (only within character classes). 
	@{FG SHINE}%	@{FG TEXT}Matches 0 characters always (useful in "(foo|bar|%)").
	@{FG SHINE}*	@{FG TEXT}Synonym for "#?", not available by default in 2.0.  Available
		as an option that can be turned on.

@{BODY}"Expression" in the above table means either a single character (ex:  "#?"),
or   an   alternation  (ex:   "#(ab|cd|ef)"),  or  a  character  class  (ex:
"#[a-zA-Z]").

@ENDNODE
@NODE EXAMPLES "Examples"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

Some examples of pattern matching....

@{CODE}@{FG SHINE}@{U}Example 1@{UU}@{FG TEXT}

	@{B}@{FG HIGHLIGHT}#?it@{UB}@{FG TEXT}

@{BODY}This  will  search  for  all  words ending in 'it'.  '*it' would also do the
same.  WordMania would output the following...  (and many more!)


@{CODE}@{FG FILL}Accredit
Acquit
Admit
Adroit
Affidavit


@{FG SHINE}@{U}Example 2@{UU}@{FG TEXT}

	@{B}@{FG HIGHLIGHT}???it@{UB}@{FG TEXT}

@{BODY}This  will  search for all five letter words ending in 'it'.  Another method
of  doing this would be to use '*it' and set the word length to greater than
4 and less than 6.


WordMania would output the following...  (and many more!)


@{CODE}@{FG FILL}Admit
Audit
Await
Befit
Bruit


@{FG SHINE}@{U}Example 3 - Solving The Suns' SUNDIAL puzzles@{UU}@{FG TEXT}

	tbaihweit

@{BODY}Set   the  @{"  Word  length  greater  than  " LINK SCG_GREATER}  gadget  to  3  and  set  the
@{" MUST have these letters " LINK SCG_MUST} to 't'.  Now press @{"SEARCH!" LINK MWG_SEARCH}.  This will initiate a
search  that  will  find  all  the  anagrams  of 'tbaihweit' that consist of
atleast 4 letters and contain the letter 't'.


WordMania would output the following...  (and many more!)


@{CODE}@{FG FILL}Abet
Bait
Bate
Bath
Whet
Whit
White
Whitebait
With

@ENDNODE
@NODE DICFORMAT "Dictionary Formats"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

@{BODY}The dictionaries are straight forward ASCII text files that contain a single
word on each line.


The  file  must  be  sorted alphabetically.  The words may consist of upper,
lower or mixed characters, although this will affect case-sensitive searchs.


Any  lines  that  start  with  a  non-alphabetical character (such as ;.,?/~
!"£$%^&*(), etc.) are ignore by WordMania.


This   dictonary   format  is  fairly  standard  amongst  most  PD/Shareware
WordProcessors  and  spell  checkers  (with  the  possible  exception of the
non-alphabetical lines).


The  lists that WordMania saves out also take this format with the first few
lines used as header information (all prefixed with ';').  These saved files
can  be  fed  back into WordMania as dictionary files.  Thus allowing you to
perform  searchs  on  subsets  of  the  dictionary that have been previously
created and saved.

@ENDNODE
@NODE HISTORY "Program History"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

@{FG SHINE}Version 1.0    -    @{FG HIGHLIGHT}9 September 1996@{FG TEXT}

 First public release.

@ENDNODE
@NODE FUTURE "Future enhancements"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

@{BODY}I'm  not  sure  whether I intend to develope WordMania much further, it does
pretty much everthing I wanted it to do.  However, if you want to see any of
the  following  features  added,  or  have  some  ideas  on improvements and
addtions to WordMania then please write and let me know.  I've never had any
comments  from users of previous programs that I've written, so I doubt that
this one will receive much mail, however I live in hope!


@{CODE}Possible Future Enchancements...

@{FG SHINE}@{U}Additions to the Criteria Window@{UU}

 @{FG FILL}o@{FG TEXT}  A list of letters that should NOT be in the result string.

 @{FG FILL}o@{FG TEXT}  Options to specify link letters. ie. First letter and fourth
    letter should be the same. etc.

 @{FG FILL}o@{FG TEXT}  Option to load and save the criteria.

 @{FG FILL}o@{FG TEXT}  Creating full length anagram strings. ie. converting someones name into
    a phrase.

@{FG SHINE}@{U}General Additions@{UU}

 @{FG FILL}o@{FG TEXT}  A Dictionaries Window with options for creating and maintaining
    dictionary files.

 @{FG FILL}o@{FG TEXT}  Amigaguide on-line help.

 @{FG FILL}o@{FG TEXT}  Inclusion of a special fast dictionary format, with compacted sections
    and offsets, etc. (This would help increase speed and reduce memory/disk
    space).

 @{FG FILL}o@{FG TEXT}  Font Sensitive GUI.

 @{FG FILL}o@{FG TEXT}  Cursor key control of the results list.

@ENDNODE
@NODE CREDITS "Credits & Greetings"
@{CODE}@{JCENTER}@{FG SHINE}W - o - r - d - M - a - n - i - a 

@{FG TEXT}Version : @{FG HIGHLIGHT}1.0
@{FG TEXT}Release Date : @{FG HIGHLIGHT}9 September 1996.@{FG TEXT}
@{JLEFT}
@{BG FILL}                                                                            @{BG BACK}

All program code and design by @{FG SHINE}Vex /Shoah@{FG TEXT}.
Stonecracker decompaction routine originally
by @{FG SHINE}Jouni Korhonen@{FG TEXT} and optimized by @{FG SHINE}Squize /Shoah@{FG TEXT}.

WordMania was written in Blitz Basic 2.1 by Acid Software.
This document was written in CygnusEd Professional V3.5 by Cygnus Software.

If you have any comments, bug reports, ideas, job offers or just want to get
in touch then write to me at this address...

@{FG HIGHLIGHT}Vex,
11 Northfield Road,
Narberth,
Pembrokeshire,
WALES.
SA67 7AA@{FG TEXT}


Greetings to...

@{FG SHINE}Sharon@{FG TEXT}		- So, what's it like to be a mum?
@{FG SHINE}Ciaran@{FG TEXT}		- So, what's it like to have Sharon for a mum?
@{FG SHINE}Squize@{FG TEXT}		- Yet another one to add to our list of 'Art'!
@{FG SHINE}Paul@{FG TEXT}		- How's the chess program coming along?
@{FG SHINE}Stephen@{FG TEXT}		- How's Last Lap II going?
@{FG SHINE}Knob@{FG TEXT}		- Welcome to the wonderful world of Shoah!
@{FG SHINE}Haplo@{FG TEXT}		- I'm still waiting for the return of the Jiffy...
@{FG SHINE}Freak@{FG TEXT}		- Your jiffies on the way... Balls!2 looks real cool!
@{FG SHINE}Steve 'n Tina@{FG TEXT}	- Blatting about France, eh? It's alright for some!

@{BODY}Also  hi to Jack & Beryl at J.H.  Video, Whiskey the cat, Liane, Tony, Simon
and everyone else, especially all those that I've forgotten...



WordMania  is  dedicated  to  the  memory  of  my  father.   He  was fond of
crosswords  and  word puzzles, and this was the last program of mine that he
saw.


This one's for you dad.

@ENDNODE
@NODE MWG_STRING "Program Gadgets"
@{FG SHINE}@{B}Search String@{FG TEXT}@{UB}


This  is  the  string  that you want to perform an anagram search or pattern
match on.

@ENDNODE
@NODE MWG_DISPLAY "Program Gadgets"
@{FG SHINE}@{B}Display@{FG TEXT}@{UB}


WordMania  can  display  either  'Criteria  Matchs', 'All Matchs', or 'Exact
Matchs'. These are explained below.


@{CODE}@{FG HIGHLIGHT}'Criteria Matchs'@{FG TEXT}
@{BODY}This  is  all  the  words that match the search criteria as specified in the
Criteria Window.


@{CODE}@{FG HIGHLIGHT}'All Matchs'@{FG TEXT}
@{BODY}These are all matchs found that match the search string (be they anagrams or
pattern  matches).   This  list  will  include words that both match and not
match the criteria.


@{CODE}@{FG HIGHLIGHT}'Exact Matchs'@{FG TEXT}
@{BODY}These  are  words that match the search string and are the exact same length
as the search string.


Also see the save options in the @{" menus " LINK MENUS}.

@ENDNODE
@NODE MWG_SEARCH "Program Gadgets"
@{FG SHINE}@{B}SEARCH!@{FG TEXT}@{UB}


This  button  will  start  the  search  engine.  A 'Progress Window' will be
displayed  and will update the progress of the search, during the search the
'Display  List'  and  'Totals'  will  be update also.  The 'Progress Window'
contains an 'Abort Button' and pressing this will abort the search.


@ENDNODE
@NODE MWG_CRITERIA "Program Gadgets"
@{FG SHINE}@{B}Criteria@{FG TEXT}@{UB}


This button opens/closes the 'Search Criteria Window'.  This window also you
to  further  specifiy  the  search  parameters  for  the search engine.  The
'Search  Criteria  Window' runs asynchronous with the 'Main Program Window',
thus it can remain open through out the programs operation.


@{CODE}The 'Search Criteria Window' contains the following gadgets.

@{" Word length greater than " LINK SCG_GREATER}
@{" ...and less than         " LINK SCG_LESS}
@{" MUST have these letters  " LINK SCG_MUST}
@{" In sequence?             " LINK SCG_INSEQ}
@{" Start search in section  " LINK SCG_START}
@{" ...and end in section    " LINK SCG_END}
@{" Only match criteria      " LINK SCG_ONLYMATCH}
@{" Clear All Criteria       " LINK SCG_CLEAR}

@ENDNODE
@NODE MWG_PREFS "Program Gadgets"
@{FG SHINE}@{B}Preferences@{FG TEXT}@{UB}


This  opens  the  preferences window, from here you can control the way that
'WordMania' works.


@{CODE}The 'Preferences Window' contains the following gadgets.

@{" Dictionary File            " LINK PFG_DICTFILE}
@{" Display results as         " LINK PFG_DISPLAYAS}
@{" Load dictionary to memory? " LINK PFG_LOADDICT}
@{" Case sensitive searchs?    " LINK PFG_CASESENSE}
@{" Save preferences on exit?  " LINK PFG_SAVEEXIT}
@{" Include criteria in prefs? " LINK PFG_INCCRIT}
@{" Include length in display? " LINK PFG_INCLEN}
@{" Fast progress display?     " LINK PFG_FASTDIS}
@{" Fast section skip?         " LINK PFG_FASTSKIP}
@{" Pre-scan dictionary file?  " LINK PFG_PRESCAN}
@{" Save                       " LINK PFG_SAVE}
@{" Use                        " LINK PFG_USE}
@{" Cancel                     " LINK PFG_CANCEL}

@ENDNODE
@NODE MWG_CLEARLIST "Program Gadgets"
@{FG SHINE}@{B}Clear List@{FG TEXT}@{UB}


@{BODY}This button will clear the current 'Search Results' window and memory.
@ENDNODE
@NODE MWG_RESULTS "Program Gadgets"
@{FG SHINE}@{B}Search Results@{FG TEXT}@{UB}


This  is  the  list  of  results  from  the last search.  The display can be
switched thru three different display types using the 'Display' button.  The
current results can be cleared using the @{" Clear List " LINK MWG_CLEARLIST} button.
@ENDNODE
@NODE MWG_TOTAL "Program Gadgets"
@{FG SHINE}@{B}Total Matchs@{FG TEXT}@{UB}


This is the total of all the words found that match the search string.
@ENDNODE
@NODE MWG_EXACT "Program Gadgets"
@{FG SHINE}@{B}Exact Matchs@{FG TEXT}@{UB}


This  is the total of all the words found that match the exact length of the
search string.
@ENDNODE
@NODE MWG_CRITE "Program Gadgets"
@{FG SHINE}@{B}Criteria Matchs@{FG TEXT}@{UB}


This is the total of all the words found that match the search criteria.
@ENDNODE
@NODE MWG_WORDS "Program Gadgets"
@{FG SHINE}@{B}Words Searched@{FG TEXT}@{UB}


This is the total number of words that have been searched.
@ENDNODE
@NODE SCG_GREATER "Program Gadgets"
@{FG SHINE}@{B}Greater than @{FG TEXT}@{UB}


This  specifies  that the length of each word found must be greater than the
number  in the gadget.  So if you only wanted words that are 4 characters or
more, then you'd specify a value of 3 in this gadget.  A value of zero means
that there is no minimum length.


Defaults to 0.
@ENDNODE
@NODE SCG_LESS "Program Gadgets"
@{FG SHINE}@{B}Less than@{FG TEXT}@{UB}


This  specifies  that  the  length  of each word found must be less than the
number  in  the  gadget.   So if you only wanted words that are 6 letters or
less, then you'd specify a value of 7 in this gadget.  A value of zero means
that there is no maximum length.


Defaults to 0.
@ENDNODE
@NODE SCG_MUST "Program Gadgets"
@{FG SHINE}@{B}MUST have these letters@{FG TEXT}@{UB}


This string gadgets should contain letters that must occur in the words that
are  found.   Every  word that matchs the search string will then be checked
with  this  string  to  ensure  that  it  has these letters in it also.  For
example  if  you  only wanted words that contained all the vowels then you'd
put  "aeiou"  in  this  gadget,  and the criteria results would only contain
words with all the vowels in.


Defaults to an empty string.
@ENDNODE
@NODE SCG_INSEQ "Program Gadgets"
@{FG SHINE}@{B}In sequence?@{FG TEXT}@{UB}


This  is  used in conjunction with the @{" MUST have these letters " LINK SCG_MUST} gadget.  If
this  is  ticked  then  the contents of the 'MUST have these letters' gadget
must  occur  in  order and together as a word.  For example if you only want
words  that contained 'word' within them then you'd set the 'MUST have these
letters' gadget with the string "word" and set this gadget.  Then only words
that  had  the  string  "word" within them would be chosen.  Whereas if this
gadget wasn't checked then any word that had a 'w','o','r' and 'd' within it
(in any order) would be valid.


Defaults to off.
@ENDNODE
@NODE SCG_START "Program Gadgets"
@{FG SHINE}@{B}Search section start@{FG TEXT}@{UB}


This  allows  you to specify a particular section of the dictionary to start
the  search  in.   The  section is specified with a letter (eg.  'h').  This
gadget is only available after the full dictionary has been scanned.


Defaults to 'A'.
@ENDNODE
@NODE SCG_END "Program Gadgets"
@{FG SHINE}@{B}Search section end@{FG TEXT}@{UB}


This  allows you to specify a particular section of the dictionary where the
search  will  end.  The section is specified with a letter (eg.  'h').  This
gadget is only available after the full dictionary has been scanned.


Defaults to 'Z'.
@ENDNODE
@NODE SCG_ONLYMATCH "Program Gadgets"
@{FG SHINE}@{B}Only match the criteria@{FG TEXT}@{UB}


Normally,  when  this gadget is unchecked, the search engine keeps a list of
all  matching words whether they match the criteria or not.


This  means  that  if you were looking for all the words that ended in 'ary'
and  where  atleast  10  characters long, you would set the search string to
"*ary" and set the @{" Word length greater than " LINK SCG_GREATER} to 9.  The search engine would
then produce a list of all the words that matched '*ary' and a seperate list
of  the  ones  that  matched and where greater than 9.


However  if  you  where  just  looking  for  all words than where atleast 10
characters  long,  you'd use a search string of '*' and set the greater than
gadget  to  9.Now  this would match ALL words in the dictionary and would be
rather slow and consume a vast amount of memory.


So  in this case you would only want the search engine to match the criteria
and  not the search string and the criteria, and you'd do this by using this
gadget.


Defaults to off.
@ENDNODE
@NODE SCG_CLEAR "Program Gadgets"
@{FG SHINE}@{B}Clear all the criteria@{FG TEXT}@{UB}


This  resets  all  the  gadgets  in  the  criteria  window  to there default
settings.
@ENDNODE
@NODE PFG_DICTFILE "Program Gadgets"
@{FG SHINE}@{B}Dictionary file to use for search@{FG TEXT}@{UB}


This  is the dictionary file that the program uses to find it's words.  This
file  is  essential  for  the  program to function.  The program can use any
dictionary file that is suitably formatted.  See @{" Dictionary formats " LINK DICFORMAT}.


Defaults to "Dictionary".
@ENDNODE
@NODE PFG_DISPLAYAS "Program Gadgets"
@{FG SHINE}@{B}Display results as @{FG TEXT}@{UB}


@{BODY}This specifies the display style for the results window.

@{CODE}The words can be displayed in the following formats:

@{FG HIGHLIGHT}'Capitalised'@{FG TEXT}
This will capitalise each word (i.e.  Moonchild)

@{FG HIGHLIGHT}'UpperCase'@{FG TEXT}
This will change the word so that it is all uppercase (i.e.  MOONCHILD)

@{FG HIGHLIGHT}'LowerCase'@{FG TEXT}
This will change the word so that it is all lowercase (i.e.  moonchild)

@{FG HIGHLIGHT}'Unaltered'@{FG TEXT}
@{BODY}This  will leave the word unformatted so that it is displayed in exactly the
same way as it appears in the dictionary file.


This  display format is also the format used in the output file of any lists
that are saved.


Defaults to "Capitalised".
@ENDNODE
@NODE PFG_LOADDICT "Program Gadgets"
@{FG SHINE}@{B}Load dictionary into memory?@{FG TEXT}@{UB}


If  this  gadget is checked then the program will attempt to load the entire
dictionary  file  into  memory  and use it there, if the dictionary file has
been  compacted  with Stonecracker then it will be decrunched to memory.  If
this  gadget is unchecked then the dictionary will be access from disk as it
is needed.


Please  note:   If the dictionary file is Stonecracker then this option must
be set, as the file cannot be accessed from disk in this compacted format.


Defaults to on.
@ENDNODE
@NODE PFG_CASESENSE "Program Gadgets"
@{FG SHINE}@{B}Case sensitive searchs?@{FG TEXT}@{UB}


This  specifies  whether  the  program  should  treat  all  strings  as case
sensitive  or not.  I don't think there is much point in this option, but it
might be of use to someone, I put it in for completeness, actually I haven't
really tested it properly! (Sorry :).


Defaults to off.
@ENDNODE
@NODE PFG_SAVEEXIT "Program Gadgets"
@{FG SHINE}@{B}Save prefs on exit@{FG TEXT}@{UB}


If  this  option  is  set  then  the  program  will  automatically  save the
preferences (and criteria if applicable) when you quit the program.


Defaults to off.
@ENDNODE
@NODE PFG_INCCRIT "Program Gadgets"
@{FG SHINE}@{B}Include the criteria in the prefs@{FG TEXT}@{UB}


This option will save the criteria with the preferences.  Therefore when you
next  run  the  program the criteria will be set to the values that you used
when you saved the preferences.


Defaults to on.
@ENDNODE
@NODE PFG_INCLEN "Program Gadgets"
@{FG SHINE}@{B}Include the length in the search results display@{FG TEXT}@{UB}


Chosing this option will add the length in characters to the words displayed
in the results window.


Defaults to on.
@ENDNODE
@NODE PFG_FASTDIS "Program Gadgets"
@{FG SHINE}@{B}Fast progress display@{FG TEXT}@{UB}


When  this  option is active (i.e.  ticked) the program will only update the
display  when  it  matchs  a  word.   If  this option is not chosen then the
program  will  update  the  'Words  Searched'  total after each word that it
checks.   It's  best  to  use  the @{" Fast progress display " LINK PFG_FASTDIS} on most machines,
unless you've got a really fast machine in which case feel free to show off!


Defaults to on.
@ENDNODE
@NODE PFG_FASTSKIP "Program Gadgets"
@{FG SHINE}@{B}Fast section skip@{FG TEXT}@{UB}


When  this option is on the search engine will automatically skip dictionary
sections  that is doesn't need to look at.  For example if the search string
doesn't  contain  the  letter  'a'  then  there's  no point looking at words
starting with the letter 'a', so this section will skipped (Clever, eh?  :).
This  fast skipping will only work if the dictionary has been fully scanned,
this  is either done with the prescan option or after the first full search.
Dictionary section offset are saved with the preference file.


Defaults to on.
@ENDNODE
@NODE PFG_PRESCAN "Program Gadgets"
@{FG SHINE}@{B}Pre-scan dictionary file@{FG TEXT}@{UB}


In  order  for WordMania to perform at is best it needs to know the position
of  each dictionary section within the dictionary.  When the dictionary file
is  changed  or the load to memory flag is changed, WordMania can optionally
scan  the  dictionary  file  after  you close the Preference window, this is
quicker  than  a  normal search and allows WordMania to perform fast section
skips  and  allows  you to choose a start and end section.  If you turn this
option  off  then  WordMania  will update it's internal list during the next
FULL dictionary search.


Defaults to on.
@ENDNODE
@NODE PFG_SAVE "Program Gadgets"
@{FG SHINE}@{B}Save preferences@{FG TEXT}@{UB}


This   will   save   the   changes   that  you  have  made  into  the  files
'ENVARC:WordMania.Prefs'  and  'ENV:WordMania.Prefs'  and  return you to the
main window.

@ENDNODE
@NODE PFG_USE "Program Gadgets"
@{FG SHINE}@{B}Use preferences@{FG TEXT}@{UB}


This   will   use  the  changes  that  you  have  made  by  saving  them  to
'ENV:WordMania.Prefs' and return you to the main window.

@ENDNODE
@NODE PFG_CANCEL "Program Gadgets"
@{FG SHINE}@{B}Cancel preference changes.@{FG TEXT}@{UB}


This  will  cancel  the  changes  that  you have made and return to the main
window.

@ENDNODE

@NODE INDEXNODE "Index"
@{CODE}

            @{FG HIGHLIGHT}@{BG TEXT} - A - @{FG TEXT}@{BG BACK}

 @{" ...and end in section      " LINK "SCG_END"} @{FG FILL} - Search Criteria Window@{FG TEXT}
 @{" ...and less than           " LINK "SCG_LESS"} @{FG FILL} - Search Criteria Window@{FG TEXT}


            @{FG HIGHLIGHT}@{BG TEXT} - C - @{FG TEXT}@{BG BACK}

 @{" Cancel                     " LINK "PFG_CANCEL"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Case sensitive searchs?    " LINK "PFG_CASESENSE"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Clear All Criteria         " LINK "SCG_CLEAR"} @{FG FILL} - Search Criteria Window@{FG TEXT}
 @{" Clear List                 " LINK "MWG_CLEARLIST"} @{FG FILL} - Main Window@{FG TEXT}
 @{" Credits                    " LINK "CREDITS"}
 @{" Criteria                   " LINK "MWG_CRITERIA"} @{FG FILL} - Main Window@{FG TEXT}
 @{" Criteria Matchs            " LINK "MWG_CRITE"} @{FG FILL} - Main Window@{FG TEXT}


            @{FG HIGHLIGHT}@{BG TEXT} - D - @{FG TEXT}@{BG BACK}

 @{" Dictionary File            " LINK "PFG_DICTFILE"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Dictionary format          " LINK "DICFORMAT"}
 @{" Display                    " LINK "MWG_DISPLAY"} @{FG FILL} - Main Window@{FG TEXT}
 @{" Display results as         " LINK "PFG_DISPLAYAS"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Distribution               " LINK "DISTRIBUTION"}


            @{FG HIGHLIGHT}@{BG TEXT} - E - @{FG TEXT}@{BG BACK}

 @{" Exact Matchs               " LINK "MWG_EXACT"} @{FG FILL} - Main Window@{FG TEXT}
 @{" Examples                   " LINK "EXAMPLES"}


            @{FG HIGHLIGHT}@{BG TEXT} - F - @{FG TEXT}@{BG BACK}

 @{" Fast progress display?     " LINK "PFG_FASTDIS"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Fast section skip?         " LINK "PFG_FASTSKIP"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Future Updates             " LINK "FUTURE"}


            @{FG HIGHLIGHT}@{BG TEXT} - H - @{FG TEXT}@{BG BACK}

 @{" How to use                 " LINK "HOWTOUSE"}


            @{FG HIGHLIGHT}@{BG TEXT} - I - @{FG TEXT}@{BG BACK}

 @{" In sequence?               " LINK "SCG_INSEQ"} @{FG FILL} - Search Criteria Window@{FG TEXT}
 @{" Include criteria in prefs? " LINK "PFG_INCCRIT"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Include length in display? " LINK "PFG_INCLEN"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Introduction               " LINK "INTRO"}


            @{FG HIGHLIGHT}@{BG TEXT} - L - @{FG TEXT}@{BG BACK}

 @{" Load dictionary to memory? " LINK "PFG_LOADDICT"} @{FG FILL} - Preference Window@{FG TEXT}


            @{FG HIGHLIGHT}@{BG TEXT} - M - @{FG TEXT}@{BG BACK}

 @{" Menus                      " LINK "MENUS"}
 @{" MUST have these letters    " LINK "SCG_MUST"} @{FG FILL} - Search Criteria Window@{FG TEXT}


            @{FG HIGHLIGHT}@{BG TEXT} - O - @{FG TEXT}@{BG BACK}

 @{" Only match criteria        " LINK "SCG_ONLYMATCH"} @{FG FILL} - Search Criteria Window@{FG TEXT}


            @{FG HIGHLIGHT}@{BG TEXT} - P - @{FG TEXT}@{BG BACK}

 @{" Patterns                   " LINK "PATTERNS"}
 @{" Pre-scan dictionary file?  " LINK "PFG_PRESCAN"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Preferences                " LINK "MWG_PREFS"} @{FG FILL} - Main Window@{FG TEXT}
 @{" Program history            " LINK "HISTORY"}
 @{" Programs gadgets           " LINK "GADGETS"}
 @{" Programs menus             " LINK "MENUS"}


            @{FG HIGHLIGHT}@{BG TEXT} - S - @{FG TEXT}@{BG BACK}

 @{" Save                       " LINK "PFG_SAVE"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Save preferences on exit?  " LINK "PFG_SAVEEXIT"} @{FG FILL} - Preference Window@{FG TEXT}
 @{" Search Results             " LINK "MWG_RESULTS"} @{FG FILL} - Main Window@{FG TEXT}
 @{" Search String              " LINK "MWG_STRING"} @{FG FILL} - Main Window@{FG TEXT}
 @{" SEARCH!                    " LINK "MWG_SEARCH"} @{FG FILL} - Main Window@{FG TEXT}
 @{" SHOAH                      " LINK "SHOAH"}
 @{" Start search in section    " LINK "SCG_START"} @{FG FILL} - Search Criteria Window@{FG TEXT}
 @{" System requirements        " LINK "SYSREQ"}


            @{FG HIGHLIGHT}@{BG TEXT} - T - @{FG TEXT}@{BG BACK}

 @{" Total Matchs               " LINK "MWG_TOTAL"} @{FG FILL} - Main Window@{FG TEXT}


            @{FG HIGHLIGHT}@{BG TEXT} - U - @{FG TEXT}@{BG BACK}

 @{" Use                        " LINK "PFG_USE"} @{FG FILL} - Preference Window@{FG TEXT}


            @{FG HIGHLIGHT}@{BG TEXT} - W - @{FG TEXT}@{BG BACK}

 @{" Word length greater than   " LINK "SCG_GREATER"} @{FG FILL} - Search Criteria Window@{FG TEXT}
 @{" Words Searched             " LINK "MWG_WORDS"} @{FG FILL} - Main Window@{FG TEXT}

@ENDNODE
