Template:BridgeHandNE/doc

Purpose
This template generates a diagram typical of those used in literature to present a partial deal in contract bridge.

Usage
The template receives 10 elements of data:
 * 1 for a descriptive label
 * 1 for designation of the lead and
 * 8 for the card rank holdings in each of four suits for each of two players - North and East.

Either create or copy the blank template sample below, insert in article and complete as follows:

1. Add an optional Label parameter to appear in the upper left quadrant of the diagram. It allows context details of the hand to be added if relevant or appropriate.
 * Separate entries by use of a line break . Typical entries may include:

Data length must be short to fit aesthetically in upper left quadrant of the diagram; use a line break where necessary. Use line breaks between data entries. The parameter may be left blank or removed entirely.
 * 1) A deal or board number, eg. "Board 16" or "Deal 5"
 * 2) Scoring method, eg. "Matchpoints", "IMPs" or "Rubber"
 * 3) Contract, eg. "South in 4"
 * 4) Vulnerability: "E-W vulnerable", "N-S vulnerable", "Both vulnerable", "None vulnerable"

2. Add an optional Lead parameter to appear in the lower left quadrant of the diagram. It can indicate the specific card led or who is on lead, eg. "Lead: 2", or "East leads A", or "South on lead". The parameter may be left blank or removed entirely.

3. Each of the two lines of code represents a hand in the order of: North, East with suits in each line in the order of: spades, hearts, diamonds, clubs. When using the blank template sample from below, replace each emdash ( &amp;mdash; ) with the card ranks (A, K, Q, etc.) of each suit held by each player. Use an emdash to show a void.

4. Optionally but preferably, add a thin space ( &amp;thinsp; ) between ranks of cards for improved readability and aesthetics. Very long card holdings may require the use of hair spacing ( &amp;#8202; ) to keep the suit rank listing to a single line; two-line card holdings are possible but are aesthetically disruptive.

Example
Text beside diagram.

Text below diagram.

which results in:

Text beside diagram.

Text below diagram.

Blank template
Copy, paste and complete the following blank template into your article in accordance with the instructions at the top of this documentation page and the example illustrated above. Text beside diagram.

Text below diagram.

which renders the following blank deal diagram: Text beside diagram.

Text below diagram.

Surrounding text
1. The diagram is programmed to be placed to the left margin of the page.
 * Text relevant to the diagram should be added to its right by continuing it immediately after the last closing brace of the template.
 * Text for a new subject or topic should be started below the diagram by inserting the template clear after the last closing brace and then continuing with text.

2. If appropriate, a separate auction table may be used to supplement the deal diagram. It will normally be placed immediately to the right.