Crossword 0.6 README
--------------------

This application lets you construct swedish type crosswords. It has support
for word databases so you can search for word with certain letters in specified
positions.

It does not support random crossword generation.

Requirements
------------
The application is written in Gambas with the QT component. It uses sqlite
for datatabase access so you need the following installed:

* Gambas
* QT
* sqlite

It is developed in english but contains a swedish translation.

Installation
------------
The application can be installed anywhere in your path but the databases should
be installed in a directory where you have write permissions. The first time you
start the application you must specify the path to the databases with "Settings."

Function overview
-----------------
You have a grid with 16 x 23 squares. In each square you can have
one of:

1) A solution letter and, optionally, a "deflection arrow" (see below)
2) A Clue

You enter letters in the grid by typing them on the keyboard. To specify
a clue or change any other property of a square you must use the function
"Properties" (or F4) when the square is current.

You can use the mouse or the keyboard arrows to make a square current
(indicated with red).

To use the search function or to copy/cut you must mark (indicated with grey)
the squares by pressing the shift key on them. You can also use the 
arrow keys and holding shift down while moving. It is currently not possible
to mark a square with the mouse. In fact, if you click in a square all marks
are removed.

To delete the content in a square you can press "Space" or "Delete".

Solution letters and deflection arrows
--------------------------------------
The solution letters are always displayed when a crossword is constructed. 
When printing a crowssword it is possible to hide them :)

Deflection arrows are used to "bend" a word down or to the right. They are
only visible guides in the final crossword and does not affect the construction
in any other way. Deflection arrows are also used to put a big arrow (right or
down) in a square when you want to have a sentence or two words as solution.

A special type of "letter" is if you enter the character "*". It is used to
fill the square with dark grey to indicate a unnused square.

Squares with solution letters can also have one fat border to indicate the
end of a word or to "frame" a certain letter. Fat borders can be used if you
not are able to find words in all possible combinations but should be avoided
in a perfect crossword.

Clues
-----
To specify a clue you must make the square current and click on "Properties" or F4.
A square can contain one or two clues, each with "exits" in all possible directions.
As the squares are rather small you must use short clues or the text will overwrite
adjacent squares. Use line breaks in clues to use several lines. It is possible to
change the font size between 4 and 10 pixels with 5 as the default.

The search function
-------------------
To use the search function you must have at least one database active (see below).

To search for possible words mark the position with shift and arrows and press "Search"
or F3. All matches will be displayed in the right frame. If you double click a word
it will be written in the marked squares. Double click does not currently fill outside
the mark so you may have to complete the word manually.

By default the search function only searches for words having exactly the number of 
characters the mark has. To modify this behavior uncheck the checkboxes "Lock start" and
"Lock end" to search for words beginning with, ending with or containing the marked
section.

Images
------
By using "properties" on the active square you can specify the type of the
square to "picture". Use the bottom picture field to browse for a image file
and specify its column and row span. The image will be scaled to exactly
the specified number of squares. When you save a crossword file only a reference
to the image will be stored. If you delete or move the image to another path afterwards
it will be displayed as a red cross. The same happens if you specify an invalid
image file.

Databases
---------
The application comes with some sample databases in english, swedish and computer terms.
Only one database can be active but you may change database with "Settings" or the key
F2.

Edit the current database
-------------------------
Use the function "Word list" - "Edit". In this window you can:

1) Edit or delete words
2) Add new words

To edit or delete a word use the search function to search for words and then click on them.

To add words:

1) Use the tab "Add" and write or paste a text in the textarea
2) Press the "Filter" button to remove all unwanted characters
3) Verify that the filtered text looks ok (you may edit it if you want)
4) Press the "Save" button

The words are inserted in the current database. As the words are replaced into the
database it does not matter if they already exists.

Zoom
----
You can change the zoom level between 1 and 4 with "Zoom" spinbox or the keys "1" to "4".

Changelog
---------
0.5 - 051024
    - Initial release
    
0.6 - 051026
    - Expanded databases
    - LIMIT search in database, selectable
    - Fixed bug in empty double clue
    - Fixed bug in left arrow
    - Fixed window title
    - Code cleanup
    
0.7 - 051101
    - Support for pictures
    - Moved all printing to separate module
    - Selectable clue background color
    - Reworked dialog for type of square
    - Shortcuts (1-4) for zooming
