View source for User:Fpuelz/Using KrossWordPuzzle

==Using KrossWordPuzzle==
===Library===
The library is shown after the game has started. If it's not shown, you can always switch back to the library by using the Library-tab on top:

[[Image:krosswordpuzzle_menu.jpg]]

The library shows all your crosswords. In the toolbar of the library you have some options to fill your library: Download, Import, New Crossword. There are also options to organize your library: Delete, New Folder. Some buttons need a crossword to be selected.

[[Image:krosswordpuzzle_library_toolbar.jpg]]


====Downloading Crosswords====
In the library click '''Download''' to open the download dialog. Select a provider to show a list of offered crosswords. A preview is shown for the selected crossword. To find a specific crossword you can use the search line.
You can change the target folder for downloaded crosswords at the bottom of the download dialog.
Click '''Ok''' to download the selected crossword.

[[Image:krosswordpuzzle_dialog_download.jpg|thumb|350px|center|The download dialog]]


====Importing Crosswords====
In the library click '''Import''' to import local crossword files to your library. You can also add crosswords to the library by dropping files, eg. from dolphin. The following file formats are supported:
::* '''.puz''' (AcrossLite)
::* '''.kwp''' (for '''k'''ross-'''w'''ord-'''p'''uzzle)
::* '''.kwpz''' (compressed .kwp-files)


====Exporting Crosswords====
In the library click '''Export''' to export the selected crossword. The following file formats are supported for exporting:
::* '''.puz''' (AcrossLite)
::* '''.kwp''' (for '''k'''ross-'''w'''ord-'''p'''uzzle)
::* '''.kwpz''' (compressed .kwp-files)
::* '''.pdf''' (Acrobat Reader, Okular, ...)
::* '''.ps''' (Post script)
::* '''.png''' (Image format)
::* '''.jpg''' (Image format)


====Creating New Crosswords====
In the library click '''New Crossword''', which will open a dialog. In the '''General''' tab you can choose a crossword type and set some information like the authors name (you) or the size of the crossword. You can also create user defined crossword types. See [[#Crossword_Types|Crossword Types]] for an overview of the available crossword types. All settings can be changed later via '''Edit -> Crossword Properties...'''.

[[Image:krosswordpuzzle_dialog_newcrossword_1.jpg|thumb|350px|center|The general tab of the create new dialog]]


In the '''Template''' tab you can choose to use a template. Templates are complete crosswords, but without clue texts or answer letters. You can use them to quickly create new crosswords by just filling in the clues. If you have a good [[#Using_the_Dictionary|dictionary]] this can be really easy.

You can easily create new templates by saving a crossword with the option '''Save As Template''' enabled (use '''Game -> Save As'''). If you want the new template to appear in the Create New dialog you should save it to the default Templates place (which appears in the Save As dialog).

[[Image:krosswordpuzzle_dialog_newcrossword_2.jpg|thumb|350px|center|The template tab of the create new dialog]]

After clicking '''Ok''' the new crossword is created and shown in edit mode. See [[#Editing_Crosswords|Editing Crosswords]] to see how to edit that new crossword.


====Organize your library====
To delete the selected crossword from the library click '''Delete'''. You can also delete a folder from the library. This will delete all contained crosswords in that folder.
To create new folders click '''New Folder''', which will ask you for a name for the new folder.

You can also drag and drop crosswords from one folder of the library to another.


===Printing===
You can view a print preview using '''Game -> Print Preview'''. To print a crossword use '''Game -> Print...'''. Besides all the default printing options, you can choose a color for empty cells in '''Options >>> Crossword tab'''.


===Playing Crosswords===
Choose a crossword to play from the library and then click '''Open''' in the toolbar or double click that crossword. See [[#Library|Library]] for instructions on how to add crosswords to your library.

This is how the main window will look after opening the crossword:
[[Image:krosswordpuzzle_play_1.jpg|thumb|425px|center|The crossword tab with an opened crossword]]

You can click each letter cell to set the focus to that cell. When you press a letter key, that letter will be put into the focused cell and the next letter cell of the current clue will be focused. Normally you will start with focusing the first letter cell of a clue and then just write the answer using the keyboard.

In the statusbar there is a progress bar, showing you the percentage of filled letter cells, the solving progress. When you filled in all letter cells you can '''Check''' your solution using '''Move -> Check''' or the corresponding button in the toolbar. If you want to start again, ie. clearing all answers, use '''Move -> Clear Answers'''. You can also clear answers / letters using the context menu or using the '''Eraser Tool'''. The Eraser Tool can be enabled using '''Move -> Eraser''' or by the corresponding toolbar button. When it's enabled you can clear letter cells by clicking them or clear answers by clicking clue cells (that obviously only works, when clue cells are visible).


====Navigation====
There are many ways to navigate through the crossword. First you can use the '''arrow keys''' to move the focus.

There are other actions for navigation (some have default shortcuts):
:* '''Select First Letter''' (default shortcut ''Home''), selects the first letter of the current clue
:* '''Select Last Letter''' (default shortcut ''End''), selects the last letter of the current clue
:* '''Select Clue With Switched Orientation''' (default shortcut ''Tab''), selects the clue with a different orientation without selecting another letter
:* '''Select First Clue''', selects the first clue
:* '''Select Previous Clue''', selects the previous clue
:* '''Select Next Clue''' (default shortcut ''Return''), selects the next clue
:* '''Select Last Clue''', selects the last clue

All those actions are listed in the '''Move''' menu:
[[Image:krosswordpuzzle_menu_move.jpg|thumb|250px|center|The move menu]]


To change the zoom level you can use the '''zoom slider''' in the status bar, use the '''View''' menu or hold Ctrl and zoom in/out with the mouse wheel. You can show the whole crossword in the window using '''View -> Fit to page'''.

To pan the view you can enable the pan mode using '''View -> Pan''' or the pan button in the toolbar. In pan mode you can use the mouse to drag the view. You can also pan when not in pan mode by pressing and holding Ctrl.

You can always '''Save''' your current work with all currently filled letters.


====Hints, Solving====
When you're stuck while trying to solve a crossword you can get help. There are different actions for getting help: 
:* Solve the whole crossword (using '''Move -> Solve''')
:* Solve a whole clue (using the context menu on a letter cell and then choose '''Solve Across Clue''' or '''Solve Down Clue''')
:* Solve a single letter (using '''Move -> Hint''' or the context menu on a letter cell and then choose '''Hint For This Cell''')


====Clue List====
The clue list isn't shown for all crossword types by default (eg. not for swedish crosswords). You can show/hide it via '''Settings -> Clue List'''. It shows a list of all clues of the current crossword with it's current answers. You can click each clue in the list to pan the view to that clue. After clicking a clue you can directly start writing the answer.


====Solution Toolbar====
The solution toolbar is only shown for crosswords that have a '''solution word'''. Such crosswords have some special letter cells, namely solution letter cells. Those solution letter cells are marked by parenthesized numbers, indicating their position in the solution word. All solution letters together form the solution word.

You can change the solution letters either in the solution toolbar or in the crossword, they synchronize themselves. You can toggle the solution toolbar via '''Settings -> Toolbars Shown -> Solution'''.



===Editing Crosswords===
To edit crosswords you first need to enable the edit mode using '''Edit -> Edit Mode''' or the corresponding button in the toolbar. When you have just created a new crossword using the Create New dialog the edit mode is enabled automatically. In edit mode all correct letters are shown and empty cells are visible and focusable. You can [[#Navigation|navigate]] through the crossword in the same way it's done when the edit mode isn't enabled. Changes to letter cells will change their correct letters (indicated by the blue color of the letters). 
::{|cellpadding="2"
|[[Image:Im-status-message-edit.png]]||'''Note'''||You should fill all correct letters, so that no letter stays blank, otherwise solving won't work correctly.
|}

When you created a new crossword using a template you just need to fill in the letters and clues and you're done. Otherwise you first need to add clues and images if you want (not all crossword types allow images!).

Different crossword types have different rules, allow different sets of cell types. You can convert your crossword to any type you want, see [[#Converting_Crosswords|Converting Crosswords]].


====Adding Clues, Images====
To add new clues or images, select an empty cell and then use '''Edit -> Add Clue''' or '''Edit -> Add Image''' (which won't be shown if the current crossword type doesn't allow image cells). If the current crossword type allows '''Double Clue Cells''', you can also select a clue cell and then choose Edit -> Add Clue.
This will immediatly add the clue or image into the crossword with default settings. Read the next sections to see how to change the newly created clue or image.


====Changing Clues====
You can change clues using the '''Current Cell Dock'''. If it's not shown you can enable it with '''Settings -> Current Cell'''.

When you have selected a clue it will look like this:

[[Image:krosswordpuzzle_dock_currentcell_1.jpg|thumb|175px|center|The current cell dock]]

You can change the clue text and insert special characters using the button on the right of the clue input line.
The orientation of the clue can be changed to '''Horizontal''' or '''Vertical''' if that's possible. When it's not possible, it's because the clue is too long for the other orientation or because there are other cells preventing the orientation to be changed (eg. a clues answer can't cross other clue cells).

When you have [[#Managing_the_Dictionary|setup a dictionary]] the dictionary group box is shown in the Current Cell dock. See [[#Using_the_Dictionary|Using The Dictionary]] to see how to use it.

When the current crossword type allows or requires clue cells to be shown the Current Cell dock includes a group of buttons to change the '''answer offset'''. The answer offset is the offset of the first letter cell of the answer to it's clue cell (topleft, top, topright, left, on clue cell, right, bottomleft, bottom, bottomright). American crosswords disallow clue cells, ie. the answer offset is always 'on clue cell'. Swedish crosswords require clue cells, ie. the answer offset can't be 'on clue cell'.

'''Answer lengths''' can be changed interactively by dragging the bar after the last letter cell of a clue. The answer length is changed by adding / removing letter cells from the clue. You can't make an answer shorter than the minimum allowed answer length of the current crossword type.


====Changing images====
'''TODO'''


====Converting Crosswords====
You can convert every crossword to every other crossword type. To do this, use '''Edit -> Crossword Properties...''', click the '''Crossword Type''' section and then click the '''Convert...''' button. This will open the conversion dialog, where you can choose the crossword type to convert to. On the bottom of the dialog an info line is shown which informs you about cells, that will get removed by the conversion. You can undo each conversion.

See [[#Crossword_Types|Crossword Types]] for a list of available crossword types.


====Managing the Dictionary====
First you need to have a MySQL server installed and running. '''TODO: More text here...'''

You can open the dictionary dialog via '''Settings -> Dictionary...'''.

[[Image:krosswordpuzzle_dialog_dictionary.jpg|thumb|350px|center|The dictionary dialog]]

On the right of the dialog you can see a list of all words in your dictionary. Each word can have an associated clue text.
On the left you can see a toolbox with three sections: '''Fill Dictionary''', '''Edit''' and '''Backup'''.

To add words with their clue texts from existing crosswords you can use '''Extract From Library''', which extracts all words from all crosswords in your library or '''Extract From Crosswords...''', which lets you choose crossword files to extract words from. You can also add words (without clue texts) from plain text dictionary files using '''Add Words From Dictionary...'''. Normally /usr/dict or /usr/share/dict contains such dictionaries.

To add single words use '''Add Entry''' from the '''Edit''' section. Change the word directly in the list. To remove all selected words from the dictionary use '''Remove Selected''', to clear the dictionary use '''Clear Dictionary'''.

The '''Backup''' section contains two buttons: '''Import (CSV)...''' and '''Export (CSV)...'''. These can be used to import/export the dictionary to/from comma seperated files (CSV). CSV-Files can also be imported with spread sheet applications. You can use those files as backup or to share your dictionary with others.


====Using the Dictionary====
'''TODO: More description of adding clues using the dictionary'''
In the Current Cell dock, you can search for matching answers using wildcard patterns (? for one arbitrary letter, * for any number of arbitrary letters). Those patterns are automatically generated based on the letters that are already in the crossword. Therefore matching answers are automatically offered when adding new clues.