Revision as of 04:48, 17 September 2007

This is the documentation for the MediaWiki plug-in for drawing Hex diagrams.

Each diagram consists of the board settings and the pieces that are placed on the board. All this is enclosed in <hex>...</hex> tags.

Syntax

The description of a Hex diagram consists of a series of words. The first letter of each word is called the command, and the remaining letters are its arguments. There are commands for specifying the board size and for putting stones on the board.

Setting up the board

The commands for setting up the board all take a single numeric argument. The commands are:

• R: Specifies the number of rows of the board.
• C: Specifies the number of columns of the board.
• Q: Specifies whether the coordinates should be printed next to the board. Zero means no, any other number means yes. By default, they are not shown.

Examples

• R5 sets the number of rows to 5.
• Q1 makes the coordinates appear next to the board.
• Q0 explicitly makes the coordinates disappear.

Setting up single stones

The commands for setting up stones all take a coordinate as their argument. Coordinates are written in the form f7, where f is the column and 7 is the row.

The commands are:

• B for a blue stone.
• R for a red stone.
• H for a horizontal stone (equivalent to B).
• V for a vertical stone (equivalent to R).
• S or * for a star.
• P or + for a plus.

When you want to add move numbers, put a single digit (0-9) between the command and the coordinate, for example R5e4 when Red puts his fifth move onto e4.

Examples

• Ba4 puts a blue stone (B) in the first column (a) of the fourth row (4).
• R7b1 puts a red stone (R) in the second column (b) of the first row (1) and labels it with a seven (7).

Automatically numbered moves

There is a special command (M) for setting up numbered sequences of moves. The first of these moves is for Red. After each M command, the color changes and the move number is increased automatically.

Currently, the number of moves is restricted to 10, but this may be extended if there is the need for it.

Formatting diagrams usefully

Depending on the situation and the intent of a diagram, it may be formatted in different styles. Large diagrams should be distributed over several lines, to make editing and reading easier. The suggested format is:

1. Board size and coordinates,
2. Setup stones: One line per color,
3. The moves in the order they are played.

See the diagrams below for examples.

Examples for Complete Diagrams

A simple board with stones in all four corners

Numbered moves

All possible fields