Glossary
A complete, illustrated guide to what all the parameters in X2 do
These parameters are specified in the HTML code that places the
crossword into your web page. A sample crossword is shown below - we
will use this puzzle to illustrate how the different sections of the X2
applet work. Normally a crossword wouldn't have both a Prompt Bar and a
Tool Area, but they are both displayed here for completeness.
Here is the X2 code that makes the crossword look the way it does. Don't worry if this looks a bit
lengthy and overwhelming. This is a full set of parameters, for the purposes of illustrating every option.
Not every crossword needs this full set - many of the parameters are optional, and the crossword will
display well without them all being included.
Click on each line to be taken to its description, and an illustration.
Most of the parameters should be self explanatory, as we've done
our best to choose obvious parameter names - but we've added a few
notes to help you along the way. In the example images we've changed the
colour to magenta (#990066) to
highlight which feature of the crossword display is affected by each
parameter.
NB : the APPLET and parameter tags are case sensitive.
archive="X2.jar" code="X2"
This specifies where the java applet lives, the first one: archive="X2.jar"
can be a path to another location, but code="X2" cannot be changed.
width=668 height=490
This is where the size of the display area that contains the
crossword plus title/prompt/clue lists if any. 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 values
needed depend on how may options and what sizes are specified in the
main list of options below (called parameters).
<param name="Puzzle" value="TG004.xrd">
This optional 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.
If left out then the puzzle is assumed to be "crossword.xrd" and to be
inside the jar file. The text is case sensitive.
<param name="CellSize" value="27">
This optional parameter set the crossword cell size in pixels. The default is 28.
This sets the overall size of the crossword, by setting the size of the
grid boxes (cells) in pixels. All the font sizes in the crossword itself
are calculated from this dimension. The overall size of the grid is
CellSize times the number of cells in each direction plus any inset
pixels. For example, an 11 x 11 puzzle will come out about 330 pixels
square with a CellSize value="30" (30 px x 11 cells). A 13 x 13 grid will
be at least 390 x 390 pixels (30 px x 13 cells).
The top example here has CellSize value=22, and the second example has CellSize value=34.
<param name="BkgdColour" value="#990066">
This optional parameter sets the overall background colour for the puzzle, in hexadecimal.
The Title and Prompt area backgrounds are automatically computed from this
colour by making a lighter tint of the background colour. If this parameter is left out, black (#000000) is used.
<param name="TextColour" value="#990066">
This optional parameter sets the overall colour for the Title, Down & Across headers, and
Arrows in the Clue List headers. This parameter overrides any specific text colour settings.
<param name="FrameColour" value="#000000">
This optional parameter sets the colour for the
frame line drawn around all the layout elements:
the grid, title, clues, prompt and/or toolbar areas. The default value if
omitted is black.
<param name="Spacing" value="8">
This optional parameter sets the spacing between the elements of the crossword layout, ie the
Crossword, Title, Clue List, and Tool Bar / Prompt Bar.
This sets the overall spacing in pixels between elements of the
crossword, between the grid, title, clues, prompt and/or toolbar areas.
Changing the value of this padding will affect your crossword dimensions
(ie the Height and Width dimensions in the top <APPLET> tag).
The top example has 8 pixels of space : <param name="Spacing" value="8">
The second example has 16 pixels of space : <param name="Spacing" value="16">
Grid Appearance and Options
Crossword Grid
<param name="GridCellColour" value="#990066">
This is the colour of the normally-white crossword cells, where letters are entered.
White (#FFFFFF) is the default.
<param name="GridLineColour" value="#990066">
This is the colour of the crossword grid lines. Black (#000000) is the default.
<param name="GridBlockColour" value="#990066">
This is the colour of the normally-black crossword squares, or 'outs'.
Black (#000000) is the default.
This is the colour that highlights the active word in the Grid, and the
active clue in the Clue List area. It's best if this is a light colour!
The default colour is mid-grey.
<param name="LetterColour" value="#990066">
This is the colour that letters appear in when they're first typed into
the grid. It is also the colour used for the numbers in the crossword grid. The default is black (#000000).
<param name="CorrectWordColour" value="#990066">
This is the colour the letters in the grid turn once a whole word
has been entered correctly. It is also colour of the little square
that appears in the top right hand corner of the crossword cells to
indicate that a letter has been revealed (ie a hint given).
The default is bright red - so you're likely to want to edit this parameter!
<param name="CompletedColour" value="#113566">
This is the colour the letters in the grid turn once the entire
crossword is correctly completed. The example here also shows a revealed letter, which
has a small square in the top right-hand corner to indicate that it is a 'cheat' letter.
The default colour is bright blue.
Title Area Appearance and Options
The Title area is a panel where the name of the crossword is
displayed. You can also include an optional 'tagline' which is shown in
smaller type below the main title and can provide a link URL to
somewhere, the author's home page for example. This is also the place
you can add an optional image/graphic, such as a company logo.
<param name="TitleAreaPosition" value="TOP">
This is a required parameter.
This parameter will either turn the Title ON (value="TOP") or OFF (value="NONE").
<param name="TitleAreaHeight" value="40">
This optional parameter sets the height in pixels of the Title area. The default is 32.
<param name="TitleAreaTextAlign" value="LEFT">
Optional. This sets the alignment of the Title text. The default is "LEFT", other options are
"CENTRE, or "RIGHT". The initial letters will also work : ie value="L", "C", or "R".
<param name="TitleName" value="The Gourmet 04">
This parameter specifies the text which is displayed in the Title area. If this parameter is left
out then no text is displayed. The font and text size can not be altered.
This optional parameter alls for a link to a small image, which can be placed in the Title area.
The image can be in a different directory or subdirectory. GIF, JPEG, and PNG are all supported.
When the TitleAreaTextAlign is aligned to the LEFT or CENTRE, the image will appear on the far left margin of the Title Bar.
When the Title text is aligned RIGHT, the image will align with the far right margin of the Title Bar.
The TitleAreaHeight parameter will
almost definitely have to be increased to provide room for the
image, as well as the entire crossword height value.
Optional. A line of small text that appears under the main title, which
can be a writer's byline, copyright notice, or something else. The text can
be linked to another web site (see below).
Optional. The URL for the Title tag to make it into a link. This can be a relative link within your web site, or an
remote link, in which case make sure you include "http://" in the URL. If this parameter is left out, the
tag line will just be plain text.
<param name="TitleTagColour" value="#990066">
This optional parameter sets the colour of the Title tag line, in hexadecimal. The default is black.
Prompt Bar Appearance and Options
The Prompt Area (or Bar) is an optional panel where the current clue is
displayed, duplicating the text from the Clue List. It can be used instead of the Clue List, too.
At the end of a correctly completed crossword it is also used to
display the congratulatory message or completion text. It can also
provide an optional link to a URL on completion, that could be another
puzzle, another area of your website, or a remote web location.
Crosswords with picture cluesmust have the Prompt Bar enabled, as these small illustrations
can only be displayed in this area.
If you wish to use the Buttons, then use the
Tool Area (which can also display Prompt Clues and
Completion Messages). However, if you don't want to display any of the
Buttons, then just use the Prompt Bar.
<param name="PromptAreaPosition" value="BOTTOM">
This parameter specifies where the Prompt Area appears in
relation to the Crossword Grid. Possible values are "TOP", "BOTTOM",
or "NONE". The letters "T", "B", and "N" will also work. The default
is "BOTTOM". To stop the Prompt Area appearing, you need to actively
turn it off using value="NONE".
<param name="PromptAreaHeight" value="48">
This optional parameter sets the height of the Prompt Area in pixels. If you have picture clues,
this dimension will need to be changed. Setting the value to -1 will reset it to the default (32 pixels).
<param name="PromptAreaWidth" value="390">
This optional parameter can be used to specify different widths for the Prompt Area.
The default value is -1, which means the full width of the puzzle will be used.
<param name="PromptAreaTextAlign" value="LEFT">
This optional parameter specifies how the clue text is aligned in the Prompt Bar.
You can use "LEFT", "CENTRE", or "RIGHT". "L", "C" and "R" will also work. The default value is "LEFT".
Clue List Area Appearance and Options
The Clue List gives a full, scrolling list of all clues in the Crossword. Each clue is highlighted when the
corresponding set of cells in the crossword are selected, and vice versa.
The Clue List can be replaced with the Prompt Area, however this will only display one clue at a time.
<param name="ClueAreaPosition" value="SIDE">
This parameter sets where the Clue List appears. The options are "NONE", "SIDE", and "BOTTOM".
The "SIDE" option is always at the right of the crossword grid.
<param name="ClueAreaWidth" value="200">
This parameter is an important one, specifying the width of the Clue Area in pixels. If the clues in
your crossword are long, you will probably need to adjust this value until the clues fit. Remember to adjust the
entire crossword width when you change this value.
<param name="ClueListBackColour" value="#990066">
This optional parameter specifies the colour for the background of the Clue List.
The default is white (#FFFFFF).
<param name="ClueListTextColour" value="#990066">
This optional parameter specifies the colour of the clue text. The default is black (#000000).
Tool Area Appearance and Options
The Tool Area is an enhanced Prompt Panel where the operational buttons
can be displayed. You can also have the current clue displayed (prompt clue) if you like.
A Tool Area can usually replace a Prompt Bar, except that it cannot display picture clues.
At the end of a correctly completed crossword the Tool Area is used
to display the congratulatory message. It can also provide an optional
link to a URL, which could be another puzzle, another area on your
website, or a remote web location.
Options to control the Tool Area include:
<param name="ToolAreaPosition" value="BOTTOM">
This parameter sets the position and appearance of the Tool Area.
The default is "NONE", ie the Tool Area won't appear. "BOTTOM" is the
only other option, and makes the Tool Area to appear underneath the
crossword.
<param name="ToolAreaHeight" value="48">
This optional parameter sets the height of the Tool Area. The default is 32 pixels.
<param name="ToolAreaWidth" value="390">
This optional parameter sets the width of the Tool Area, in pixels.
The default value is the full width of the crossword and clue area (value="-1" will cause the applet to
calculate the full width automatically for you).
<param name="ToolAllowReset" value="1">
Optional. Including this parameter and setting its value to "1" makes the
"Reset" button appear in the tool bar. It can be turned off either
by simply deleting the parameter, or by setting value="0".
The "Reset" button clears all letters from the
crossword grid, including correct answers and "revealed" marks.
<param name="ToolAllowTidy" value="1">
Optional. Including this parameter and setting its value to "1" makes the
"Tidy" button appear in the tool bar. It can be turned off either by
simply deleting the parameter, or by setting value="0".
The "Tidy" button will remove all incorrect letters
from the crossword grid, leaving correct letters in place. It will
also delete correct letters from any incomplete words.
<param name="ToolAllowRevealLetter" value="1">
Optional. Including this parameter, with a value set to "1", will make the "Letter"
button appear in the tool bar. It can be turned off either by
simply deleting the parameter, or by setting value="0".
This button will reveal the letter that is in the highlighted
square in the crossword. Revealed letters have a small square in
their top right hand corner.
<param name="ToolAllowRevealWord" value="1">
Optional. Including this parameter, with a value set to "1", will
make the "Word" button appear in the tool bar. It can be turned off either by
simply deleting the parameter, or by setting value="0".
This button will reveal the entire word that is highlighted in
the crossword. Revealed words have a small square in the top right
hand corner of each letter's cell.
<param name="ToolAllowRevealAll" value="1">
Optional. Including this parameter, with a value set to "1", will make the "All"
button appear in the tool bar. It can be turned off either by
simply deleting the parameter, or by setting value="0".
The "All" button will reveal the entire crossword. It's probably not a
button you'll want to have active for your users, but it will save you from having to solve
the crossword every time you want to check the completion message
and completed puzzle word colours!
A revealed crossword with have a small square in the top right
hand corner of every cell in the crossword. Clicking the
"Reset" button will delete all words, including all "revealed"
marks.
<param name="ToolAllowPrompt" value="1"
This parameter places the 'Prompt clue' into the Tool Area. This
means that the clue associated with the current highlighted word in
the crossword will appear in the Tool Area, as well as be
highlighted in the Clue List. It can be turned off either by
simply deleting the parameter, or by setting value="0".
It is possible to only use the Prompt Clues, and not display the
Clue List at all, if space is tight on your web page.
Completing the Crossword
<param name="CompletedName" value="Congratulations! Now try the next puzzle...">
Optional. This is the message which appears in the Prompt area once a puzzle is completed. Edit as you
like!
Optional. The 'Completed' message will become a link to the
specified URL if this parameter is used, where the full URL is
included in the value specification. To link to a remote web page, remember to
include http:// in the path name.
Your browser does not support Java, so nothing is displayed.
This message is shown if the user does not have Java enabled in
their browser. You can, of course, change the text to read something
else, or provide a link to further information about how they can
enable Java on their computer.
