source: spip-zone/_plugins_/pgn4spip/branches/doc/pgn4spip parameters.txt @ 90061

Last change on this file since 90061 was 90061, checked in by jack@…, 6 years ago

Avant de tout casser on passe le trunk dans "branches"

File size: 4.4 KB
Line 
1Associate to each short name of options a long name that can be used as paramater of the [pgn prm=value] tag
2The two following examples, about moving automatically the pieces every second, are equivalent:
3
4[pgn autoplayMode=loop delay=1000] 1. e4 Nf6 [/pgn]
5
6[PGN am=l d=1000] 1. e4 Nf6 [/PGN]
7___________
8
9The two following examples, about puzzles in .pgn file knowing its URL, are equivalent:
10
11[pgn movesDisplay=puzzle
12 extendedoptions=true
13 pgndata=http://localhost/spip/plugins/pgn4spip/pgn4web/tactics.pgn]
14[/pgn]
15
16[pgn md=p eo=t pd=http://localhost/spip/plugins/pgn4spip/pgn4web/tactics.pgn][/pgn]
17___________
18
19List of parameters:
20
21    // the [value by default] is in square brackets in first position in the list after //
22    $optName = array( // of long names of options, an alternative to the short names
23    'am'    => 'autoplayMode',           // [n]one |(g)ame | (l)oop
24    'bbch'  => 'boardBorderColor',       // [E0E0E0] was 000000
25    'bd'    => 'buttonsDisplay',         // [c]ustom, (h)idden, (s)tandard
26    'bch'   => 'backgroundColorHex',     // [F6F6F6] was FFFFFF, (t)ransparent to use the parent's background color
27    'bsch'  => 'boardShadowColor',       // [t]ransparent no shadow | (b)order | nbr
28    'cbch'  => 'controlBackgroundColor', // [F0F0F0] was standard buttons
29    'cd'    => 'commentsDisplay',        // [n]ewline, (i)nline,(h)idden
30    'ctch'  => 'controlTextColor',       // [696969] was 000000
31    'd'     => 'delay',                  // [3000] was 1000 in ms
32    'dch'   => 'darkColor',              // [E0E0E0] was C6CEC3
33    'fcch'  => 'fontCommentsColor',      // [000080]
34    'fcs'   => 'fontCommentsSize',       // [m]oves <- fontMovesSize
35    'fh'    => 'frameHeight',            // [""], (p)age, (b)oard, nbr, overriding textHeight. See FrameHeightEval()
36    'fhch'  => 'fontHeaderColor',        // [000000]
37    'fhs'   => 'fontHeaderSize',         // [14] was 16
38    'fmch'  => 'fontMovesColor',         // [000000]
39    'fms'   => 'fontMovesSize',          // [14] was 16
40    'fp'    => 'framePadding',           // [13] was 0
41    'fw'    => 'frameWidth',             // [p]age, (b)oard, nbr, overriding textHeight
42    'hch'   => 'highlightColor',         // [ABABAB] was DAF4D7
43    'hd'    => 'headerDisplay',          // [j]ustified | (h)idden | (c)entered | (l)ive | (v)ariations
44    'hl'    => 'horizontalLayout',       // [t]rue, (f)alse
45    'hm'    => 'highlightMode',          // [b]order, (s)quare, (n)one
46    'hmch'  => 'highlightMovesColor',    // [E0E0E0] was DAF4D7 | (b)ackground for no highligh
47    'ig'    => 'initialGame',            // [f]irst | (l)ast | (r)andom
48    'ih'    => 'initialHalfmove',        // [s]tart | (e)nd | (r)andom | (c)omment | (v)ariation | nbr
49    'iv'    => 'initialVariation',       // [0]
50    'l'     => 'layout',                 // [h]orizontal, (v)ertical. See OptionParser()
51    'lch'   => 'lightColor',             // [F6F6F6] was EFF4EC. suffix 'h' stands for hex
52    'md'    => 'movesDisplay',           // [f]igurine | (t)ext | (p)uzzle | (h)idden | (l)ive
53    'pf'    => 'pieceFont',              // [d]efault based on pieceSize | (a)lpha | (m)erida | (u)scf | (s)vgchess
54    'ps'    => 'pieceSize',              // [d]efault <- squareSize
55    'rd'    => 'refreshDemo',            // [f]alse | (t)rue if md="t"
56    'rm'    => 'refreshMinutes',         // [1] minute if md="t"
57    'ss'    => 'squareSize',             // [26] was 28
58                                         // textHeight: nbr, optional if frameHeight
59    'tm'    => 'textMargin'              // [13] was 0. Set left/right margin width of the  textual section, header and/or moves text
60                                         // textWidth: nbr, optional if frameWidth
61                    );
62    $skipPrms = array( // of other options (extendedoptions, height) to be skiped
63    'eo'    => 'extendedoptions',        // [f]alse, (t)rue
64    'h'     => 'height'                  // [auto] = DEFAULT_HEIGHT. Height of the module
65                    );
66    $pgnPrms = array( // of pgn options to indicate alternative (remote) source
67    'fs'    => 'fenString',              // Initial position in format FEN
68    'pd'    => 'pgnData',                // URL of the PGN file
69    'pe'    => 'pgnEncoded',             // PGN game encoded
70    'pi'    => 'pgnId',                  // id of the pgnText textarea
71    'pt'    => 'pgnText'                 // PGN game
72                    );
Note: See TracBrowser for help on using the repository browser.