User:Bongolium500/tree/doc

This is a template for rendering simple family trees consisting of boxes and connecting lines based on an ASCII art-like syntax. The trees are displayed as HTML tables using CSS attributes, and may contain arbitrary wiki markup within the boxes.

Example usage[[edit] | [edit source]]

This code:

{{tree/start|style=background:white;}}
{{tree | | | | | | AUG | | | | | | AUG={{ColorIntLink|black|Augustus Mengsk|u=x}}}}
{{tree | | | | | | |!| | | | | | }}
{{tree | AIL | | ANG |-|v|-|KAT| AIL={{ColorIntLink|black|Ailin Pasteur|u=x}}|ANG={{ColorIntLink|black|Angus Mengsk|u=x}}|KAT={{ColorIntLink|black|Katherine Mengsk|u=x}}}}
{{tree | |!| | | | |,|-|^|-|.| | }}
{{tree | JUL |-|v|ARC| |DOT| |JUL={{ColorIntLink|black|Juliana Pasteur|u=x}}|ARC={{ColorIntLink|black|Arcturus Mengsk|u=x}}|DOT={{ColorIntLink|black|Dorothy Mengsk|u=x}}}}
{{tree | | | | |!| | | | | | | | }}
{{tree | | | | VAL | | | | | | | | VAL={{ColorIntLink|black|Valerian Mengsk|u=x}}}}
{{tree/end}}

Produces this:

Parameters[[edit] | [edit source]]

This template produces one row in a family tree table. The template accepts up to 99 unnamed parameters describing the contents of the table. Each parameter specifies a tile or a box.

Tiles are line drawing symbols consisting of horizontal and vertical lines and various corners and crossings thereof. Tiles are specified using single-character symbols that more or less approximate the shape of the tile in appearance. A special case of a tile is the empty tile, specified by a single space character. A table of supported tiles is given below.

,

.

`

'

^

v

(

)

-

!

+

F

7

L

J

A

V

C

D

~

:

%

*

#

n

N

&

y

{

}

$

Y

[

]

x

X

t

T

_

;

Boxes can contain arbitrary wiki markup. The contents of boxes are specified using additional named parameters appended to the template call. Each box is three tiles wide and normally has a 2 pixels wide black border. Boxes can have any name that is a valid template parameter name, although single character names should be avoided to prevent conflicts with tile symbols.

Style attributes[[edit] | [edit source]]

The appearance of the boxes may be controlled by the optional template parameters border and boxstyle. The former sets the width of the box border in pixels, while the latter can be used to append arbitrary CSS declarations directly to the box style attributes. For example, the following code:

{{tree/start|style=background:white;}}
{{tree|border=0|boxstyle=background:#dfd;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}}
{{tree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }}
{{tree|border=0|boxstyle=background:#dfd;| | FOO | | BAR | |FOO=Box 3|BAR=Box 4}}
{{tree/end}}

produces a result like this:

Box 1

Box 2

Box 3

Box 4

Style attributes can even be set for individual boxes, as in the example below:

{{tree/start|style=background:white;}}
{{tree| | | | |WHITE| | | | |WHITE=White}}
{{tree| |,|-|-|'|!|`|-|-|.| }}
{{tree|RED  |~|GREEN|~|BLUE |RED=Red box|GREEN=Green|BLUE=Blue
|boxstyle_RED  =background-color: #faa;
|boxstyle_GREEN=background-color: #afa;
|boxstyle_BLUE =background-color: #aaf;
}}
{{tree/end}}

which produces the output:

White

Red box

Green

Blue

NOTE: When specifying style attributes for individual named boxes, make sure the box names are aligned to the left side of area reserved for them in the template call (as in "|RED |" instead of "| RED |" in the example above). Otherwise the template will end up looking for a style parameter with spaces in its name.

The {{tree/start}} template also accepts an optional style parameter that can be used to set CSS styles for the entire table.Category:Template documentation