Module:Chessboard-3x3/doc

Chessboard Module

This module is to support a basic implementation of a chessboard, but for a 3x3 version.

The user is invited to learn by example from the below.

The following:

{{ChessDiagram|
|'''A famous chess match'''
|rd|  |bd|qd|kd|bd|  |rd
|pd|pd|pd|pd|  |ql|pd|pd
|  |  |nd|  |  |nd|  |  
|  |  |  |  |pd|  |  |  
|  |  |bl|  |pl|  |  |  
|  |  |  |  |  |  |  |  
|pl|pl|pl|pl|  |pl|pl|pl
|rl|nl|bl|  |kl|  |nl|rl
|Scholar's Mate – Black is checkmated. 
}}

...produces the following:

A famous chess match

	a	b	c	d	e	f	g	h
8									8
7									7
6									6
5									5
4									4
3									3
2									2
1									1
	a	b	c	d	e	f	g	h

Scholar's Mate – Black is checkmated.

Notice that the first argument is blank.

They may be presented as left or right thumbnails by invoking tleft or tright for the first argument, as follows:

A famous chess match

	a	b	c	d	e	f	g	h
8									8
7									7
6									6
5									5
4									4
3									3
2									2
1									1
	a	b	c	d	e	f	g	h

Scholar's Mate – Black is checkmated.

A famous chess match

	a	b	c	d	e	f	g	h
8									8
7									7
6									6
5									5
4									4
3									3
2									2
1									1
	a	b	c	d	e	f	g	h

Scholar's Mate – Black is checkmated.

{{ChessDiagram|tleft
|'''A famous chess match'''
|rd|  |bd|qd|kd|bd|  |rd
|pd|pd|pd|pd|  |ql|pd|pd
|  |  |nd|  |  |nd|  |  
|  |  |  |  |pd|  |  |  
|  |  |bl|  |pl|  |  |  
|  |  |  |  |  |  |  |  
|pl|pl|pl|pl|  |pl|pl|pl
|rl|nl|bl|  |kl|  |nl|rl
|Scholar's Mate – Black is checkmated. 
}}

{{ChessDiagram|tright
|'''A famous chess match'''
|rd|  |bd|qd|kd|bd|  |rd
|pd|pd|pd|pd|  |ql|pd|pd
|  |  |nd|  |  |nd|  |  
|  |  |  |  |pd|  |  |  
|  |  |bl|  |pl|  |  |  
|  |  |  |  |  |  |  |  
|pl|pl|pl|pl|  |pl|pl|pl
|rl|nl|bl|  |kl|  |nl|rl
|Scholar's Mate – Black is checkmated. 
}}

... and so it is seen they behave as thumbnails are expected to.

You can add arrows in various directions and configurations:

{{ChessDiagram|
|'''Examples of arrows'''
|  |ud|  |  |  |  |  |  
|lr|rd|lr|  |  |ox|  |  
|  |ud|  |  |  |  |  |  
|  |  |  |  |  |  |  |  
|  |  |  |ul|ua|ur|  |  
|  |xx|  |la|kl|ra|  |  
|  |  |  |dl|da|dr|  |  
|  |  |  |  |  |  |  |  
|
}}

...produces the following:

Examples of arrows

	a	b	c	d	e	f	g	h
8									8
7									7
6									6
5									5
4									4
3									3
2									2
1									1
	a	b	c	d	e	f	g	h