Table of modx snippet call parameter for renderShobiBoard
| Parameter | Description | example | Default | Defined |
|---|---|---|---|---|
| size | define size of the board. If not defined, the size is medium | &size=`small` | None | large, small |
| caption | Caption of the board | &caption=`Figure 1.` | None | |
| comment | Define the initial comment in the comment area | &comment=`Hello everybody!` | None | |
| noComment | if set to 1, the board will display without comment section | &noComment=`1` | 0 | 0,1 |
| type | 0 indicates the normal shogiboard. If set to 1,the board will be rendered as tsumeshogi board. if set to 3, then Komadai will not be rendered | &type=`1` | 0 | 0,1,3 |
| sOnHand | Sente on Hand in string format | &sOnHand=`s,s,g` (先手持ち駒 銀二、金) | None | |
| gOnHand | Gote on Hand pieces in string format | &gOnHand=`p,p,p,l,n` (後手持ち駒 歩三、香、桂) | None | |
| sOnBoard | Sente on board pieces in string format | &sOnBoard=`59k,49g` (先手５九玉、４九金) | Initial positions | *1 |
| gOnBoard | Gote on board pieces in string format | &gOnBoard=`11l,21n,22k,14p` (後手１一香、２一桂、２二玉、１四歩) | Initial positions | *1 |
| sName | Name to be shown as Sente Player | &sName=`Habu` | Sente/Black | *1,*2 |
| gName | Name to be shown as Gote Player | &sName=`Watanabe` | Sente/Black | *1,*2 |
| markerAt | Move Marker location that indicates previos move | &markerAt=`34` shows marker at ３四 | 00 : not visible | XX where 1<X<9 and 00 |
| moves | If present, then the board is loaded with moves data and buttons are added | &moves=`"s-2627","g-8483","s-2526","g-8584` | None | |
| url | If present, then the kifu data is loaded from the specified url and board is prepped accordingly | &url=`http://thissite.come/kifudata/kifu.kif` The target file need to be in Kakinoki kifu file format (aka kif format) | None | |
| file | If present, then the specified kifu file is loaded from the 'assets/Resources/kifu/' path and board is prepped accordingly | &file=`kifufile.kifu` the file need to be in Kakinoki kifu file format. | None | |
| src | If present, then the src parameter content is treated as a kakinoki format kifu file and board is prepped accordingly | See example in Render board from kifu text | None | |
| smooth | If set to 1, make a piece move the "gliding" move. Uses Jquery UI's switchClass effect | &smooth=`1` | 0 | 0,1 |
| startAt or tesuu | If either parameter is specified, then the move will start from the specified position | &startAt=`4` will show the board with moves already progressed to #4. | 0 | *3 |
| mysteryMove | If set to 1, branch move indicator shows "select" rather than the first selection | &mysteryMove=`1`: to be used with Kifu with branch moves | 0 | 0,1 |
*1 The parameter is set as a part of default property set in renderShogiBoard snippet
*2 If the referenced kifu file has this information, then those defined in the kifu file will be used.
*3 For practicality, this only works with Kakinoki style kifu
This page was originally created 12 years, 10 months ago and last updated 3 years ago