| 1 | http://localhost/spip/plugins/pgn4spip/pgn4web/board.html?help=true |
|---|
| 2 | |
|---|
| 3 | URL parameters |
|---|
| 4 | |
|---|
| 5 | - pgnText = PGN games to display |
|---|
| 6 | - pgnEncoded = encoded PGN games to display (used only by the board generator tool) |
|---|
| 7 | - fenString = FEN position to display |
|---|
| 8 | - pgnId = id of the parent's textarea containing the PGN games (parent page/frame MUST be in the same domain) |
|---|
| 9 | - pgnData = URL of the file containing the PGN games (file MUST be in the same domain) |
|---|
| 10 | |
|---|
| 11 | - refreshMinutes = live broadcast delay (default 0 = live broadcast disabled) |
|---|
| 12 | - refreshDemo = if set true sets live demo mode (default false) |
|---|
| 13 | |
|---|
| 14 | - initialGame = first | last | random | a number | a search expression (default first) |
|---|
| 15 | - initialVariation = a number (default 0) |
|---|
| 16 | - initialHalfmove = start | end | random | comment | variation | a number (default start) |
|---|
| 17 | |
|---|
| 18 | - autoplayMode = game (autoplay first game once) | loop (loops through games continuously) | none (default game) |
|---|
| 19 | - delay = autoplay delay in ms (default 1000) |
|---|
| 20 | |
|---|
| 21 | - squareSize = size of square (default 28) |
|---|
| 22 | - pieceSize = size of pieces | default (default selects piece size based on piece size) |
|---|
| 23 | - pieceFont = alpha | merida | uscf | random | default (default selects piece font based on piece size) |
|---|
| 24 | - highlightMode = border | square | none (default square) |
|---|
| 25 | - lightColorHex = light square color hex code, like FF0000 (default EFF4EC) |
|---|
| 26 | - darkColorHex = dark square color hex code, like FF0000 (default C6CEC3) |
|---|
| 27 | - highlightColorHex = highlight color hex code, like FF0000 (default DAF4D7) |
|---|
| 28 | - boardBorderColorHex = board border color hex code, like FF0000 (default 000000) |
|---|
| 29 | - boardShadowColorHex = board shadow color hex code, like FF0000, 'transparent' for no shadow, 'border' for same color as board border (default transparent) |
|---|
| 30 | |
|---|
| 31 | - buttonsDisplay = hidden | standard (use browser's standard buttons) | custom (use custom color buttons) (default hidden) |
|---|
| 32 | - controlBackgroundColorHex = control buttons background color hex code, like FF0000 (default reverts to standard buttons) |
|---|
| 33 | - controlTextColorHex = control buttons text color hex code, like FF0000 (default 000000) |
|---|
| 34 | |
|---|
| 35 | - headerDisplay = justified | centered | hidden | live | variations (default hidden) |
|---|
| 36 | - movesDisplay = figurine | text | puzzle | hidden (default hidden) |
|---|
| 37 | - textHeight = set height of the textual section, header and/or moves text, might be ignored if frameHeight is set (default 100%) |
|---|
| 38 | - textWidth = set width of the textual section, header and/or moves text, might be ignored if frameWidth is set (default 100%) |
|---|
| 39 | - textMargin = set left/right margin width of the textual section, header and/or moves text (default 0) |
|---|
| 40 | - commentsDisplay = hidden | inline (same line as moves) | newline (new lines) (default inline) |
|---|
| 41 | - fontHeaderColorHex = header color hex code, like FF0000 (default 000000) |
|---|
| 42 | - fontMovesColorHex = moves color hex code, like FF0000 (default 000000) |
|---|
| 43 | - fontCommentsColorHex = comments color hex code, like FF0000 (default 808080) |
|---|
| 44 | - fontVariationsColorHex = variations color hex code, like FF0000; if set as 'comments' fontCommentsColorHex is copied (default comments) |
|---|
| 45 | - highlightMoveColorHex = background color hex code to highlight current move, like FF0000, 'background' for no highlight (default DAF4D7) |
|---|
| 46 | - fontHeaderSize = header font size (default 16) |
|---|
| 47 | - fontMovesSize = moves font size (default 16) |
|---|
| 48 | - fontCommentsSize = comments font size; if set as 'moves' fontMovesSize is copied (default moves) |
|---|
| 49 | - fontVariationsSize = variations font size; if set as 'comments' fontCommentsSize is copied (default comments) |
|---|
| 50 | |
|---|
| 51 | - backgroundColorHex = page background color hex code, like FF0000, 'transparent' to use the parent's background color (default FFFFFF) |
|---|
| 52 | - horizontalLayout = if set true, shows header/moves text at the right of the board, below otherwise (default false) |
|---|
| 53 | - frameHeight = set height of the overall frame, as a number, as 'board' or as 'page', overriding textHeight (default not set) |
|---|
| 54 | - frameWidth = set width of the overall frame, as a number, as 'board' or as 'page', overriding textWidth (default not set) |
|---|
| 55 | - framePadding = padding within the frame (default 0) |
|---|
| 56 | |
|---|
| 57 | - showHeightWidth = if set true, calculates optimal iframe dimensions (default false) |
|---|
| 58 | - help = if set true, shows help info (default false) |
|---|
| 59 | |
|---|
| 60 | URL parameters can be shortened: for example squareSize => sq, autoplayMode => am, highlightMoveColorHex => hmch |
|---|
| 61 | Also supplied textual values can be shortened: true => t, false => f |
|---|
| 62 | |
|---|
| 63 | Every color parameter can by assigned also by name (like 'red') or using a proprietary encoding in base 64. |
|---|
| 64 | For instance, the light square color, besides using the lightColorHex parameter can be also assigned using the lightColorName or the lightColorSex parameter. |
|---|
| 65 | The latter is proprietary and used by the board generator tool. |
|---|
