Sutherland Studios

X2 Online Crosswords - Quick Start Guide

X2 User Guide

  • Home

  • Quick Start
    How to get your online crossword up and running right away

  • Advanced Design
    How to make your crossword tie in with your site design

  • Trouble-Shooting
    Help with any niggly file problems

  • Glossary
    A complete, illustrated guide to what all the parameters in X2 do

It's easy to get your X2 crossword up and running on your web site - just follow these simple steps!

1. Upload the .jar file to your server, in the appropriate directory on your site.

2. If the crossword is in a separate .xrd file, then upload it as well.

3. Open the crossword's .html file and copy and paste the code into the web page where you want the crossword to appear.

4. Edit the html file until the display size is correct, and select which colours you'd like (see below).

5. Upload the html file.

Basically, that's it!


Instructions for Play

You may like to include some instructions for your users about how to play your X2 crossword. You are welcome to use this text :

To play the crossword, just click in a square on the grid and the clue will be highlighted in the Clue List, or will show up in the Prompt Bar. Then simply enter the letters for the answer from your keyboard. The active letter will automatically progress along the word as you type. Correct words will change colour, and can not be overwritten.

Use the Arrow keys on your keyboard to move through the grid letter by letter. The Return key will jump through the grid word by word. You can also, of course, use your mouse to select a word. Clicking in an interconnected square will toggle between the Across and Down words.

You can scroll through the clues using the small Up and Down arrows at the top of the two groups of clues (Across and Down). There are also some buttons which can help you with the crossword :

  • The Tidy button removes incorrect letters and incomplete words from the grid.
  • The Letter button reveals the letter in the highlighted square.
  • The Word button reveals the highlighted word.
  • The Reset button completely clears the grid.
  • Any 'revealed' letters have a small square in the top right hand corner.

Some further details

These notes refer to the X2 applet and its parameters, which appear in the HTML file.

This is the most important line of code, that must appear in your HTML page for the crossword to show up at all :

<APPLET archive="X2.jar" code="X2" width=600 height=400></APPLET>

"Archive" specifies where the java applet lives, and can be a path to another location (eg archive="applets/X2,jar", but code="X2" must not be changed.

NB: if you have a customised version of X2, make sure that the archive attribute links to the correct file name (eg archive="X2-mine.jar"). The attribute name is also case sensitive.

width=600 height=400
This is where the size of the display area that contains the crossword plus the title and clues. You will have to change these numbers.

Unfortunately the applet isn't allowed to change its size dynamically after it is started, so it sometimes takes a bit of trial-and-error adjusting these values to get the space for the display right. The best pixel dimensions will depend on how many options and what sizes are specified in the main list of options (see the Parameter Glossary).

<param name="Puzzle" value="puzzlename.xrd">

This parameter tells the applet where the crossword 'xrd' file lives; it can be a file in the same place as the applet jar file, a URL/web address to a file elsewhere on the internet, or a file inside the .jar file. This code is case sensitive.

If left out then the puzzle is assumed to be "crossword.xrd" and to be packaged inside the .jar file.


The Crossword Title has to be specified. The parameter code runs as follows :

<param name="TitleAreaPosition" value="TOP">

This parameter will either turn the Title ON (value="TOP") or OFF (value="NONE"). For more details on Title options, please see the Glossary.


Main colour

<param name="BkgdColour" value="#990066">

This optional parameter sets the overall background colour for the puzzle. The Title and Prompt area backgrounds are automatically computed from this colour by making a lighter tint of the background colour. This works best as a dark colour. If this parameter is left out, black (#000000) is used, with shades of grey.

Selected Word

<param name="LetterSelectionColour" value="#990066">

This is the colour of the active letter entry square. You can change this to a colour that that ties in with your web site. A bright and light colour will generally work best.

<param name="WordSelectionColour" value="#990066">

This is the colour that highlights the active word in the Grid, and the active clue in the Clue List area. You can change this to a colour that fits in with your web site design. A light and not too bright colour will generally work best. Remember that the clues will also be highlighted with this colour, and need to be legible through it.

Crossword Title

The Title area is a panel where the name of the crossword is displayed, and it has two basic parameters :

1. <param name="TitleAreaPosition" value="TOP">

This parameter is required, and will either turn the Title ON (value="TOP") or OFF (value="NONE").

2. <param name="TitleName" value="The Gourmet 04">

This parameter specifies the text which is displayed in the Title area. Simply type the title into value="Type your title here" in this parameter.


Last Modified:   25 June 2007