Template:Shogi diagram/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

Usage[edit source]

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

Syntax[edit source]

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

{{shogi diagram 
| <1>
| <2>
| <3>
| <4> | <5> | <6> | <7> | <8> | <9> | <10> | <11> | <12>
| <13> | <14> | <15> | <16> | <17> | <18> | <19> | <20> | <21>
| <22> | <23> | <24> | <25> | <26> | <27> | <28> | <29> | <30>
| <31> | <32> | <33> | <34> | <35> | <36> | <37> | <38> | <39>
| <40> | <41> | <42> | <43> | <44> | <45> | <46> | <47> | <48>
| <49> | <50> | <51> | <52> | <53> | <54> | <55> | <56> | <57>
| <58> | <59> | <60> | <61> | <62> | <63> | <64> | <65> | <66>
| <67> | <68> | <69> | <70> | <71> | <72> | <73> | <74> | <75>
| <76> | <77> | <78> | <79> | <80> | <81> | <82> | <83> | <84>
| <85>
| <86>
}}

Parameters[edit source]

  • <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[edit source]

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:
  • pnx - (variant character for promoted knight)
  • plx - (variant character for promoted lance)
  • tx - (variant character for promoted pawn)
Sho shogi codes:
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 Template:Nihongo2 and the "king" of the player who is "gote" (i.e., the player moves second) is indicated by Template:Nihongo2. In even games between players of different ranks, the "king" of the higher ranked player is Template:Nihongo2, and the "king" of the lower ranked player is Template:Nihongo2. In handicap shogi, even though the player giving the handicap (上手, uwate) moves first, their "king" is Template:Nihongo2 and the "king" of the player receiving the handicap (下手, shitate) is Template:Nihongo2. In problems, the "king" of the attacking (or mating) side is Template:Nihongo2 and the "king" of the defending side is Template:Nihongo2. To indicate Template:Nihongo2 for "gote" (e.g., the lower ranked player in an even game is "gote") or Template:Nihongo2 for "sente", insert ak instead of k into the template.

Sente or gote[edit source]

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.

  • - ps
  • - pg

Last move played[edit source]

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.

  • - rg
  • - rgl

Pieces-in-hand[edit source]

Pieces-in-hand are entered directly into parameters <3> and <85>. The following characters (and templates) can be used: Template:Nihongo2 for "pawn", Template:Nihongo2 for "lance", Template:Nihongo2 for "knight", Template:Nihongo2 for "silver", Template:Nihongo2 for "gold", Template:Nihongo2 for "bishop", and Template:Nihongo2 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 Template:Nihongo2 (7).

Exhaustive piece exemplification[edit source]

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[edit source]

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

  • rah - indicate start position for a move one square to the right (rah is for 'right arrow half')
  • rat - indicate movement from left to right (rat is for 'right arrow tip')
  • ras - indicate start position from right to left (ras is for 'right arrow start')
  • lra - indicate movement from right to left or left to right (lra is for 'left right arrow')
  • lah - indicate start position for a move one square to the left (lah is for 'left arrow half')
  • lat - indicate movement from right to left (lat is for 'left arrow tip')
  • las - indicate start positiong for movement from left to right (las is for 'left arrow start')
  • uah - indicate start position for a move one square upward (kadl is for 'up arrow half')
  • uat - indicate movement from bottom to top (uat is for 'upward arrow tip')
  • uas - indicate start position for movement from bottom to top (uas is for 'up arrow start')
  • uda - indicate movement from bottom to top or top to bottom (uda is for 'up down arrow')
  • dah - indicate start position for a move one square downward (dah is for 'down arrow half')
  • das - indicate start position for movement from top to bottom (das is for 'down arrow start')
  • dat - indicate movement from top to bottom (dat is for 'downward arrow tip')
  • durh - indicate start position for a move one square diagonally upward to the right (durh is for 'diagonal up right half')
  • dau - indicate movement diagonally upward to the right (dau is for 'diagonal arrow upward')
  • daus - indicate start position for movement diagonally upward to right (daus is for 'diagonal arrow upward start')
  • da - indicate movement diagonally left to right (da is for 'diagonal arrow')
  • ddlh - indicate start position for a move one square diagonally downward to the left (ddlh is for 'diagonal down left half')
  • dad - indicate movement diagonally downward to the left (dad is for 'diagonal arrow downward')
  • dads - indicate start position for movement diagonally downward to left (dads is for 'diagonal arrow downward start')
  • dulh - indicate start position for a move one square diagonally upward to the left (dulh is for 'diagonal up left half')
  • daau - indicate movement diagonally upward to left (daau is for 'diagonal arrow averse upward')
  • daaus - indicate start position for movement diagonally upward to left (daaus is for 'diagonal arrow averse upward start')
  • daa - indicate movement diagonally right to left (daa is for 'diagonal arrow averse')
  • ddrh - indicate start position for a move one square diagonally downward to the right (ddrh is for 'diagonal down right half')
  • daad - indicate movement diagonally downward to right (daad is for 'diagonal arrow averse downward')
  • daads - indicate start position for movement diagonally downward to right (daads is for 'diagonal arrow averse downward start')
  • kar - indicate movement of knight upward to the right (kar is for 'knight arrow right')
  • kal - indicate movement of knight upward to the left (kal is for 'knight arrow left')
  • kadr - indicate movement of knight downward to the right (kadr is for 'knight arrow down right')
  • kadl - indicate movement of knight downward to the left (kadl is for 'knight arrow down left')
  • ddl - indicate movement of silver downward to the left (ddl is for 'diagonal down left')
  • ddr - indicate movement of silver downward to the right (ddr is for 'diagonal down right')
  • dul - indicate movement of silver downward to the left (dul is for 'daigonal up left')
  • dur - indicate movement of silver downward to the right (dur is for 'diagonal up right')
  • yy - highlighted yellow square (yy is for 'yellow')
  • gr - highlighted gray square (gr is for 'gray')

Examples[edit source]

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

Even game between players of same rank[edit source]

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.

Gote
Pieces-in-hand: none
☖ pieces in hand: -
987654321 
1
       2
3
         4
         5
         6
7
       8
9
☗ pieces in hand: -
Sente
Pieces-in-hand: none
{{Shogi diagram|tright
|<small>Gote<br/>Pieces-in-hand: ''none''</small>
|-
|lg|ng|sg|gg|kg|gg|sg|ng|lg
|  |rg|  |  |  |  |  |bg|  
|pg|pg|pg|pg|pg|pg|pg|pg|pg
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|ps|ps|ps|ps|ps|ps|ps|ps|ps
|  |bs|  |  |  |  |  |rs|  
|ls|ns|ss|gs|ks|gs|ss|ns|ls
|-
|<small>Sente<br/>Pieces-in-hand: ''none''</small>}}




Even game, sente and gote reversed[edit source]

Sente
Pieces-in-hand: none
☖ pieces in hand: -
987654321 
1
       2
3
         4
         5
         6
7
       8
9
☗ pieces in hand: -
Gote
Pieces-in-hand: none



{{Shogi diagram|tright
|<small>Sente<br/>Pieces-in-hand: none</small>
|-
|lg|ng|sg|gg|akg|gg|sg|ng|lg
|  |rg|  |  |  |  |  |bg|  
|pg|pg|pg|pg|pg|pg|pg|pg|pg
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|ps|ps|ps|ps|ps|ps|ps|ps|ps
|  |bs|  |  |  |  |  |rs|  
|ls|ns|ss|gs|aks|gs|ss|ns|ls
|-
|<small>Gote<br/>Pieces-in-hand: none</small>}}



Even game, gote lower ranked player[edit source]

Gote
Pieces-in-hand: none
☖ pieces in hand: -
987654321 
1
       2
3
         4
         5
         6
7
       8
9
☗ pieces in hand: -
Sente
Pieces-in-hand: none



{{Shogi diagram|tright
|<small>Gote<br/>Pieces-in-hand: none</small>
|-
|lg|ng|sg|gg|akg|gg|sg|ng|lg
|  |rg|  |  |  |  |  |bg|  
|pg|pg|pg|pg|pg|pg|pg|pg|pg
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|ps|ps|ps|ps|ps|ps|ps|ps|ps
|  |bs|  |  |  |  |  |rs|  
|ls|ns|ss|gs|aks|gs|ss|ns|ls
|-
|<small>Sente<br/>Pieces-in-hand: none</small>}}



Handicap game (rook handicap)[edit source]

Uwate
Pieces-in-hand: none
☖ pieces in hand: -
987654321 
1
        2
3
         4
         5
         6
7
       8
9
☗ pieces in hand: -
Shitate
Pieces-in-hand: none



{{Shogi diagram|tright
|<small>Uwate<br/>Pieces-in-hand: none</small>
|-
|lg|ng|sg|gg|kg|gg|sg|ng|lg
|  |  |  |  |  |  |  |bg|  
|pg|pg|pg|pg|pg|pg|pg|pg|pg
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|ps|ps|ps|ps|ps|ps|ps|ps|ps
|  |bs|  |  |  |  |  |rs|  
|ls|ns|ss|gs|ks|gs|ss|ns|ls
|-
|<small>Shitate<br/>Pieces-in-hand: none</small>}}



Last move played (e.g., Position after ....)[edit source]

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:

Position after 9. Rx24
Gote
Pieces-in-hand:
Template:Nihongo2
☖ pieces in hand: -
987654321 
 1
      2
  3
        4
        5
         6
 7
       8
 9
☗ pieces in hand: -
Sente
Pieces-in-hand:
Template:Nihongo2



{{Shogi diagram|tright
|Position after 9. Rx24<br/><small>Gote<br/>Pieces-in-hand:</small> {{nihongo2|歩}}
|-
|lg|ng|sg|gg|kg|  |sg|ng|lg
|  |rg|  |  |  |  |gg|bg|  
|pg|  |pg|pg|pg|pg|pg|  |pg
|  |  |  |  |  |  |  |rsl|  
|  |pg|  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|ps|ps|ps|ps|ps|ps|ps|  |ps
|  |bs|gs|  |  |  |  |  |  
|ls|ns|ss|  |ks|gs|ss|ns|ls
|-
|<small>Sente<br/>Pieces-in-hand:</small>{{nihongo2|歩}}}}



Tsumeshogi problems[edit source]

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

Sente to mate in three
Gote
Pieces-in-hand: all the rest
☖ pieces in hand: -
987654321 
      1
         2
        3
         4
         5
        6
         7
         8
         9
☗ pieces in hand: -
Sente
Pieces-in-hand:
Template:Nihongo2



{{Shogi diagram|tright
|Sente to mate in three<br/><small>Gote<br/>Pieces-in-hand: all the rest</small>
|-
|  |  |  |sg|kg|sg|  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |ts|  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|hs|  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|-
|<small>Sente<br/>Pieces-in-hand:</small> {{nihongo2|銀}}}}



Highligting squares and indicating piece movement[edit source]

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

Highlighting squares
Gote
☖ pieces in hand: -
987654321 
         1
         2
         3
       4
         5
         6
         7
         8
         9
☗ pieces in hand: -
Sente



{{Shogi diagram|tright
|Indicting piece movement<br/><small>Gote</small>
|-
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |yy|  |gr|  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|  |  |  |  |  |  |  |  |  
|-
|<small>Sente</small>}}



Indciating piece movement
Gote
☖ pieces in hand: -
987654321 
   1
       2
       3
       4
      5
       6
    7
    8
      9
☗ pieces in hand: -
Sente



{{Shogi diagram|tright
|Highlighting squares<br/><small>Gote</small>
|-
|lat |lra  |las |ras |lra|rat |    |  |  
|    |     |kal |    |   |    |kar |  |  
|    |     |uda |    |   |    |uda |  |  
|daau|     |    |    |   |    |    |  |uat  
|    |daaus|    |    |dau|    |    |  |uda 
|    |     |    |da  |   |    |    |  |uas  
|    |daads|daus|    |   |das |das |  |das
|    |dads |daa |    |   |kadl|kadr|  |uda 
|dad |     |     |daad|   |    |    |  |dat 
|-
|<small>Sente</small>}}



Alternate versions[edit source]

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.

See also[edit source]