This file will guide you in implementing and customising the Pgn Reader to fit the needs of your website.

BASIS OF USING THE PGN READER ON A HTML PAGE

- "applet" tag and "code" attribute :

The following is the most basic way to implement the Pgn Reader on a HTML page of your website. The desing
of the applet tag is mostly the same as any other HTML tag.

<applet code="VisualInterface.class" height="480" width="700">
</applet>

The three attributes "code", "height" and "width" are necessary. The "code" attribute determines the class
that contains the applet initialisation methods and should always have the value "VisualInterface.class".
The "height" and "width" attributes represent the size of the applet.

- Size of the applet :

The size of the applet is more or less your decision. Changing the height of the applet will affect the
bottom gap (possibly hiding parts of the lower elements). The suggested height is "480". As for width, it
will affect the center gap between the visual board and the textbox (possibly overlappping them). The
suggested width is "700".

SINCE VERSION 1.3

- Auto-load : When the Pgn Reader loads, it has the possibility to automatically load a pgn hosted on
the web wheither it be to display a certain game in a certain page of your website or to simply have the
textbox of the Pgn Reader display a welcome message after loading.

To use this functionnality, you must add a "PGN" parameter to the applet tag of your HTML page as in the
following.

<applet code="VisualInterface.class" height="480" width="700">
    <param name="PGN" value="http://synergie-home.com/uploads/pgn/test.pgn">
</applet>

The file may have any extension you want, but the actual content must be plain text. If no initial pgn
is given, the Pgn Reader begins with an empty textbox.

SINCE VERSION 2.0

- Chess sets base path : 

To define the chess sets base URL, you will need to add an "IMAGEURL" parameter to the applet tag of your
HTML page with the value being the path to your main folder which in turn contain the chess sets you want
available.

For example, you placed all of your chess sets in separated subfolder located under
"http://www.mysite.com/chesssets/". You will use the following parameter tag to tell the applet where the
chess sets are located.

<applet code="VisualInterface.class" height="480" width="700">
    <param name="IMAGEURL" value="http://www.mysite.com/chesssets/">
</applet>

Note that the path must end with a '/' character. If this parameter is ommited, only the default chessset
will be available.

This option must be used with the following or it will be useless.

- Chess sets list :

To determine the names of the various chess set names you need to use the "IMAGESETS" parameter. The names
of the chess sets must be separated by a ',' character.

Suppose you have two chess sets, one located under "http://www.mysite.com/chesssets/Original" and the other
"http://www.mysite.com/chesssets/Test/Test_2". The base URL would be "http://www.mysite.com/chesssets/"
while the chess sets would be "Original" and "Test/Test_2" so you would add the following parameters to the
"applet" tag.

<applet code="VisualInterface.class" height="480" width="700">
    <param name="IMAGEURL" value="http://www.mysite.com/chesssets/">
    <param name="IMAGESETS" value="Original,Test/Test_2">
</applet>

The chess set that is initially loaded is the one included with the applet, the ones you make available are
added to the list and the user may load them as wanted (loading an external chess set can be pretty long
compared to loading the internal one). Also note that spaces aren't liked by URL translators, so it is
suggested that you write underscores instead when hosting files on the internet.

- Hosting a chess set : 

The Pgn Reader finds additionnal chess sets using a base URL and then uses the chess set's name to
determine the subfolder of this base URL that contains the image files (only supports .gif format). The
images contained by a chess set must be named in the following manner :

Black Pawn : http://www.BaseURL.com/ChessSetName/PB.gif
White Pawn : http://www.BaseURL.com/ChessSetName/PW.gif
Black Knight : http://www.BaseURL.com/ChessSetName/NB.gif
White Knight : http://www.BaseURL.com/ChessSetName/NW.gif
Black Bishop : http://www.BaseURL.com/ChessSetName/BB.gif
White Bishop : http://www.BaseURL.com/ChessSetName/BW.gif
Black Rook : http://www.BaseURL.com/ChessSetName/RB.gif
White Rook : http://www.BaseURL.com/ChessSetName/RW.gif
Black Queen : http://www.BaseURL.com/ChessSetName/QB.gif
White Queen : http://www.BaseURL.com/ChessSetName/QW.gif
Black King : http://www.BaseURL.com/ChessSetName/KB.gif
White King : http://www.BaseURL.com/ChessSetName/KW.gif

SINCE VERSION 2.2

- Multiple auto-load :

To have the Pgn Reader work with multiple PGNs at a time, it was necessary to implement a way of 
auto-loading multiple games also. To do this, we still use "param" tags.

First, we need to determine the number of games to auto-load :

<applet code="VisualInterface.class" height="480" width="700">
    <param name="NGAMES" value="3" />
</applet>

This, however does not help locate the PGNs to auto-load. In order to give the Pgn Reader that 
information you must use the "PGNx" param tags as in the following example.

<applet code="VisualInterface.class" height="480" width="700">
    <param name="NGAMES" value="3" />
    <param name="PGN1" value="http://synergie-home.com/uploads/pgn/test1.pgn">
    <param name="PGN2" value="http://synergie-home.com/uploads/pgn/test2.pgn">
    <param name="PGN3" value="http://synergie-home.com/uploads/pgn/test3.pgn">
</applet>

This does not prevent you to use the ordinary "PGN" tag for single game auto-load, but if you use
the "NGAMES" parameter too, the "PGN" tag will be ignored.

CONTACT

For any further questions or comments (do not ask for the sources, I won't give them to you), contact me
at pgn.stonkie@gmail.com .