README.txt

   1 This applet is an interactive cross-words grid for web pages. The
   2 source code is kind of open-source (modified GPL licence). I am fed up
   3 with commercial sites which used the previous version which was under
   4 pure GPL licence without giving me any buck. So now, basically you can
   5 use it on non-profit sites, and you can modify it and distribute it as
   6 long as you keep the same licence. For any other usage, please contact
   7 me.
   8
   9 You can use the arrows to move the cursor in the grid. The ENTER key
  10 changes the cursor mode (horizontal or vertical), the BACKSPACE key
  11 deletes the characters and the SPACE key shows the definition of the
  12 word the cursor is on. The Check word button checks if the word the
  13 cursor is on is correct, and locks the letters if it is, and the Give
  14 word gives you the solution for the word the cursor is on and also
  15 lock the letters.
  16
  17 A color code indicates the status of each letter. The black ones have
  18 no special status, the red ones are those obtained using the "give
  19 word" button, the green ones were checked before the grid was finished
  20 using the "check word" button (yeah, this is the beginning of
  21 cheating), and the blue ones are those found by yourself. The letters
  22 become red or green as soon as you use the buttons, and blue when you
  23 type the last letter and all are correct.
  24
  25 The <APPLET> tag contains the parameters CODEBASE wich indicates the
  26 name of the directory containing the .class files, CODE which
  27 indicates the name of the main .class file, and WIDTH and HEIGHT wich
  28 indicate the size of the rectangle containing the applet. The part of
  29 the HTML file beetween the <APPLET> and the </APPLET> tags is
  30 displayed by the browser if it can't run Java applications. In
  31 general, you put there an error message.
  32
  33 Then come the tags <PARAM> that contain the values of the various
  34 parameters specific of the applet. For this one, you have to precise
  35 the following ones :
  36
  37  - BGCOLOR is the color of the background of the gride. It's an
  38    integer which value is r*256*256 + v*256 + b where r, v and b are
  39    the three color components, normalized beetween 0 and 255.
  40
  41  - GRIDWIDTH and GRIDHEIGHT contain the number of columns and the
  42    number of rows of the gride.
  43
  44  - CONTENT is a caracter strings containing the solution of the
  45    gride. Letter after letter, line after line. The '.' indicates a
  46    black square.
  47
  48  - FONT is the font for the gride.
  49
  50  - FONTSIZE is the font size for the gride.
  51
  52  - SMALLFONT is the font for the row/column coordinates.
  53
  54  - SMALLFONTSIZE is the font size for the row/columns coordinates.
  55
  56  - CHECKWORDLABEL is the string to put in the button used to check the
  57    word at the cursor's location. If this parameter is not specified,
  58    the button does not appear.
  59
  60  - GIVEWORDLABEL is the string to put in the button used to give the
  61    word at the cursor's location. If this parameter is not specified,
  62    the button does not appear.
  63
  64  - DEFINITIONS contains the definitions of the words of the grid. This
  65    is optional and the definition-area will be activated only if this
  66    parameter is given. This string first indicates the size of the
  67    definition area, and then the word definitions, each of them
  68    starting with the coordinates of the first character of the word in
  69    the grid. See the example for the exact syntax.
  70
  71 So, for the gride above for instance, I have in my HTML file the
  72 following lines (my .class files are in a class/ directory) :
  73
  74 <APPLET CODEBASE="class" CODE="Words.class" WIDTH=400 HEIGHT=200>
  75 <PARAM NAME="BGCOLOR" VALUE="15724527">
  76 <PARAM NAME="GRIDWIDTH" VALUE="4">
  77 <PARAM NAME="GRIDHEIGHT" VALUE="4">
  78 <PARAM NAME="CONTENT" VALUE="bu.aetret..relle">
  79 <PARAM NAME="FONT" VALUE="Courier">
  80 <PARAM NAME="FONTSIZE" VALUE="24">
  81 <PARAM NAME="SMALLFONT" VALUE="Courier">
  82 <PARAM NAME="SMALLFONTSIZE" VALUE="20">
  83 <PARAM NAME="CHECKWORDLABEL" VALUE="Check word">
  84 <PARAM NAME="GIVEWORDLABEL" VALUE="Give word">
  85 <PARAM NAME="DEFINITIONS" VALUE="20x4/horizontal/a1:Ne coulera plus/b1:Une bonne question/d1:Pas lui/vertical/a1:Elle fait l'homme/a2:Pas besoin d'être comme a pour ne plus trouver cette clef/a4:Ainsi, il respire mieux">
  86 <STRONG>You need a Java-compliant WWW browser with java turned on<STRONG>
  87 </APPLET>
  88
  89 --
  90 François Fleuret
  91 24/1/2002