Template:Shogi diagram/doc

Usage
This is a template that can be used to create simple diagrams of shogi positions.

Syntax
An example of the starting position for shogi can be found at Even game between players of same rank.

Parameters

 * <1>: "floatright" or "tright" and "floatleft" or "tleft" sets the horizontal placement of the diagram in the article space: "tright" means diagram will be floated to the right allowing any text to flow to the left, and "tleft" means diagram will be floated to the left allowing any text to flow to the right. No entry for this parameter means that the diagram will simply be displayed in the default position on the left.
 * <2>: Explanation added to top of diagram. For example, a player's name, the name of an opening, etc. (optional)
 * <3>: This is the parameter for the pieces in hand for the White player (gote).
 * <4> to <84>: Each number represents a square on the board, from square 3 (9th file, ath rank: "9a") in the upper left of the board to square 83 (1st file, ith rank: "1i") in the lower right of the board. Codes for "piece types" (see below) can be entered to display pieces on the board. No entry of a code means no piece will be displayed on that particular square.
 * <85>: This is the parameter for the pieces in hand for the Black player (gote).
 * <86>: Explanation added to bottom of diagram; For example, a player's name, etc. (optional)

"Piece type" entry
Squares with no entry made for "piece type" will be displayed as an "empty square".

A "piece type" is designated by a combination of two to four letters like XXYZ.


 * The XX part represents a one or two letter combination which indicates the piece type.


 * The piece type codes are as follows:


 * [[Image:shogi_ks22.svg|25px]]/[[Image:shogi_aks22.svg|25px]] k - 玉将 (gyokushō) or 王将 (Ōshō) (king)
 * [[Image:shogi_rs22.svg|25px]] r - 飛車 (hisha) (rook)
 * [[Image:shogi_bs22.svg|25px]] b - 角行 (kakugyō) (bishop)
 * [[Image:shogi_gs22.svg|25px]] g - 金将 (kinshō) (gold)
 * [[Image:shogi_ss22.svg|25px]] s - 銀将 (ginshō) (silver)
 * [[Image:shogi_ns22.svg|25px]] n - 桂馬 (keima) (knight)
 * [[Image:shogi_ls22.svg|25px]] l - 香車 (kyōsha) (lance)
 * [[Image:shogi_ps22.svg|25px]] p - 歩兵 (fuhyō) (pawn)
 * [[Image:shogi_ds22.svg|25px]] d - 龍王 (ryūō) (dragon or promoted rook)
 * [[Image:shogi_dxs22.svg|25px]]dx - 竜王 (ryūō) (simplified character for promoted rook)
 * [[Image:shogi_hs22.svg|25px]] h - 龍馬 (ryūma) (horse or promoted bishop)
 * [[Image:shogi_pss22.svg|25px]] ps - 成銀 (narigin) (promoted silver)
 * [[Image:shogi_pns22.svg|25px]] pn - 成桂 (narikei) (promoted knight)
 * [[Image:shogi_pnxs22.svg|25px]] pnx - (variant character for promoted knight)
 * [[Image:shogi_pls22.svg|25px]] pl - 成香 (narikyō) (promoted lance)
 * [[Image:shogi_plxs22.svg|25px]] plx - (variant character for promoted lance)
 * [[Image:shogi_ts22.svg|25px]] t - と金 (tokin) (tokin or promoted pawn)
 * [[Image:shogi_txs22.svg|25px]] tx - (variant character for promoted pawn)


 * Sho shogi codes:


 * [[Image:shogi_es22.svg|25px]] e - 酔象 (suizō) (elephant)
 * [[Image:shogi_as22.svg|25px]] a - 太子 (taishi) (crown prince or promoted elephant)


 * Please note that all of the above combinations are case sensitive, so lower case letters must be used.


 * All things considered equal, the "king" of the player who is "sente" (i.e., the player who moves first) is indicated by 玉 and the "king" of the player who is "gote" (i.e., the player moves second) is indicated by 王. In even games between players of different ranks, the "king" of the higher ranked player is 王, and the "king" of the lower ranked player is 玉. In handicap shogi, even though the player giving the handicap (上手) moves first, their "king" is 王 and the "king" of the player receiving the handicap (下手) is 玉. In problems, the "king" of the attacking (or mating) side is 玉 and the "king" of the defending side is 王. To indicate 玉 for "gote" (e.g., the lower ranked player in an even game is "gote") or 王 for "sente", insert ak instead of k into the template.

Sente or gote
The Y indicates sente (black) or gote (white). For "sente" add the letter s, and for "gote" add the letter g to the end of the character string. Sente's pieces will be displayed at the bottom of the board facing up and gote's pieces will be displayed at the top of the board facing down. So a "pawn" for "sente" is indicated as ps, while a "rook" for "gote" is indicated as rg.


 * [[Image:shogi_ps22.svg|25px]] - ps
 * [[Image:shogi_pg22.svg|25px]] - pg

Last move played
The Z indicates the last move played. To indicate a piece that has just been moved, add the letter l (for last) to the end of the character string. For example, the show indicate that the last piece moved was a "rook" by "gote", use rgl.


 * [[Image:shogi_rg22.svg|25px]] - rg
 * [[Image:shogi_rgl22.svg|25px]] - rgl

Pieces-in-hand
Pieces-in-hand are entered directly into parameters <3> and <85>. The following characters (and templates) can be used: 歩 for "pawn", 香 for "lance", 桂 for "knight", 銀 for "silver", 金 for "gold", 角 for "bishop", and 飛 for "rook".

To indicate that a player is holding more than one of the same type of piece in hand, one may use piece type + (number) if repeating multiple instances of the piece is unwieldy. For example, having 7 pawns in hand can be indicated as 歩 (7).

Exhaustive piece exemplification
ps pg psl pgl ts tg tsl tgl txs txg txsl txgl

ls lg lsl lgl pls plg plsl plgl plxs plxg plxsl plxgl ns ng nsl ngl pns png pnsl pngl pnxs pnxg pnxsl pnxgl ss sg ssl sgl pss psg pssl psgl

gs gg gsl ggl

bs bg bsl bgl hs hg hsl hgl

rs rg rsl rgl ds dg dsl dgl dxs dxg dxsl dxgl

ks kg ksl kgl aks akg aksl akgl

es eg esl egl as ag asl agl

Other diagram files
These files can be used to create diagrams for explaining certain positions or indicating piece movement.


 * Shogi rah22.svg ‎ rah - indicate start position for a move one square to the right (rah is for 'right arrow half')
 * Shogi rat22.svg rat - indicate movement from left to right (rat is for 'right arrow tip')
 * Shogi ras22.svg ras - indicate start position from right to left (ras is for 'right arrow start')
 * Shogi lra22.svg lra - indicate movement from right to left or left to right (lra is for 'left right arrow')
 * Shogi lah22.svg lah - indicate start position for a move one square to the left (lah is for 'left arrow half')
 * Shogi lat22.svg lat - indicate movement from right to left (lat is for 'left arrow tip')
 * Shogi las22.svg las - indicate start positiong for movement from left to right (las is for 'left arrow start')
 * Shogi uah22.svg uah - indicate start position for a move one square upward (kadl is for 'up arrow half')
 * Shogi uat22.svg uat - indicate movement from bottom to top (uat is for 'upward arrow tip')
 * Shogi uas22.svg uas - indicate start position for movement from bottom to top (uas is for 'up arrow start')
 * Shogi uda22.svg uda - indicate movement from bottom to top or top to bottom (uda is for 'up down arrow')
 * Shogi dah22.svg dah - indicate start position for a move one square downward (dah is for 'down arrow half')
 * Shogi das22.svg das - indicate start position for movement from top to bottom (das is for 'down arrow start')
 * Shogi dat22.svg dat - indicate movement from top to bottom (dat is for 'downward arrow tip')
 * Shogi durh22.svg durh - indicate start position for a move one square diagonally upward to the right (durh is for 'diagonal up right half')
 * Shogi dau22.svg dau - indicate movement diagonally upward to the right (dau is for 'diagonal arrow upward')
 * Shogi daus22.svg daus - indicate start position for movement diagonally upward to right (daus is for 'diagonal arrow upward start')
 * Shogi da22.svg‎ da - indicate movement diagonally left to right (da is for 'diagonal arrow')
 * Shogi ddlh22.svg ddlh - indicate start position for a move one square diagonally downward to the left (ddlh is for 'diagonal down left half')
 * Shogi dad22.svg dad - indicate movement diagonally downward to the left (dad is for 'diagonal arrow downward')
 * Shogi dads22.svg‎ dads - indicate start position for movement diagonally downward to left (dads is for 'diagonal arrow downward start')
 * Shogi dulh22.svg dulh - indicate start position for a move one square diagonally upward to the left (dulh is for 'diagonal up left half')
 * Shogi daau22.svg‎ daau - indicate movement diagonally upward to left (daau is for 'diagonal arrow averse upward')
 * Shogi daaus22.svg‎ daaus - indicate start position for movement diagonally upward to left (daaus is for 'diagonal arrow averse upward start')
 * Shogi daa22.svg‎ daa - indicate movement diagonally right to left (daa is for 'diagonal arrow averse')
 * Shogi ddrh22.svg ddrh - indicate start position for a move one square diagonally downward to the right (ddrh is for 'diagonal down right half')
 * Shogi daad22.svg‎ daad - indicate movement diagonally downward to right (daad is for 'diagonal arrow averse downward')
 * Shogi daads22.svg‎ daads - indicate start position for movement diagonally downward to right (daads is for 'diagonal arrow averse downward start')
 * Shogi kar22.svg kar - indicate movement of knight upward to the right (kar is for 'knight arrow right')
 * Shogi kal22.svg kal - indicate movement of knight upward to the left (kal is for 'knight arrow left')
 * Shogi kadr22.svg kadr - indicate movement of knight downward to the right (kadr is for 'knight arrow down right')
 * Shogi kadl22.svg kadl - indicate movement of knight downward to the left (kadl is for 'knight arrow down left')
 * Shogi ddl22.svg ddl - indicate movement of silver downward to the left (ddl is for 'diagonal down left')
 * Shogi ddr22.svg ddr - indicate movement of silver downward to the right (ddr is for 'diagonal down right')
 * Shogi dul22.svg dul - indicate movement of silver downward to the left (dul is for 'daigonal up left')
 * Shogi dur22.svg dur - indicate movement of silver downward to the right (dur is for 'diagonal up right')
 * [[Image:shogi_yy22.svg|22px]] yy - highlighted yellow square (yy is for 'yellow')
 * Shogi gr22.svg gr - highlighted gray square (gr is for 'gray')

Examples
The following are examples of the types of diagrams which can be created.

Even game between players of same rank
Diagrams for such positions typically show "sente" at the bottom of the board, and "gote" at the top. Relevant information such as player names, tournament names, etc. may be entered into parameters <2> and <84> if desired.

Last move played (e.g., Position after ....)
The diagram for the position after the moves 1. P-26, 2. P-84, 3. P-25, 4. P-85, 5. G-78, 6. G-32, 7. P-24, 8. Px24, 9. Rx24 is created as follows:

Tsumeshogi problems
Example of how this diagram can be used for "tsumeshogi" problems

Highligting squares and indicating piece movement
Examples of how specific square can be highlighted and piece movement indicated.

Alternate versions
This diagram uses an Arabic numeral to designate each file, and a lowercase alphabetic character to designate each rank.

This template can be easily edited to use Arabic numerals or kanji numerals to designate ranks by simply replacing the number text.

To create a diagram with no rank or file designations, simply delete rows of number and letter.

Regardless of how the ranks are designated, care should be taken to use a form of notation consistent with the diagram to avoid confusion.