Template:tree chart/documentation

Uses Lua:

• Module:tree chart

Usage

This template produces one row in a "family tree"-like chart consisting of boxes and connecting lines based loosely on an ASCII art-like syntax. It is meant to be used in conjunction with {{tree chart/start}} and {{tree chart/end}}. The chart is displayed as HTML tables using CSS attributes, and may contain arbitrary wiki markup within the boxes.

Basic example

This code:

{{tree chart/start|align=center|summary=An example family tree}}
{{tree chart| | | |GrMa |~|y|~| GRP | |GrMa=Grandma|GRP=Grandpa}}
{{tree chart| | | | | | | |)|-|-|-|.| }}
{{tree chart| | | MOM |y| DAD | |DAISY|MOM=Mom|DAD=Dad|DAISY=[[Aunt Daisy]]}}
{{tree chart| |,|-|-|-|+|-|-|-|.| | | }}
{{tree chart| JOE | | ME  | | SIS | | |JOE=My brother Joe|ME='''Me!'''|SIS=My little sister}}
{{tree chart/end}}

produces this:

Grandma

Grandpa

Mom

Dad

Aunt Daisy

My brother Joe

Me!

My little sister

This chart visually displays the information that I have a brother Joe and a little sister; my mom married my dad; and my dad's parents were Grandma and Grandpa; and my dad's parents had another child, Aunt Daisy. The code above produces a table of size 9 rows x 18 columns as shown below.

The table structure created using the example above

Parameters

The template accepts any number of unnamed parameters with each parameter specifying a tile or a box.

• Boxes can contain arbitrary wiki markup. The content of each box is specified using additional named parameters appended to the template call. Each box is three tiles wide and normally has a black border two pixels wide. Boxes can have any name that is a valid template parameter name, subject to a minimum of two alphabetical characters.
• Tiles are line drawing symbols used to connect the boxes. They consist of various styles of horizontal and vertical lines along with corners and crossings as needed. Tiles are specified using their one- or two-character name: for the most common tiles, that character is more or less approximate to the tile's appearance. A special case of a tile is the empty tile, specified by a single space character. A table of available tiles is given below.

Solid lines:

!			,			v			.
-			)			+			(
			`			^			'

Dashed lines:

:			F			V			7
~			D			%			C
			L			A			J

Dotted lines:

Q			S			M			T
P			H			R			G
			Y			W			Z

Dashes hrzntl solid vrtcl:

fy		y		ye
f		t		e
fh		h		he

Solid hrzntl dashes vrtcl:

dj		j		jc
d		*		c
di		i		ic

Solid hrzntl dot vrtcl:

kr		r		rl
k		a		l
kq		q		ql

Dashed hrzntl dot vrtcl:

kr2		r2		rl2
k2		a2		l2
kq2		q2		ql2

Dots hrzntl solid vrtcl:

om		m		mp
o		b		p
on		n		np

Dots hrzntl dashes vrtcl:

om2		m2		mp2
o2		b2		p2
on2		n2		np2

Miscellaneous (grey background not available in, or changed from, familytree):

k3		T2		l3		b3
G2		X		K		l4
		U		E

Style attributes

The appearance of the boxes in a row may be controlled by the following optional template parameters:

• border specifies the width of the box border in pixels,
• boxstyle can be used to append arbitrary CSS declarations directly to the box style attributes. For example, the following code:

{{tree chart/start}}
{{tree chart|border=1|boxstyle=color:white; background:green; | | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}}
{{tree chart| | |,|-|^|-|.| | }}
{{tree chart|border=3|boxstyle=background:yellow; | | FOO | | BAR | |FOO=Box 3|BAR=Box 4}}
{{tree chart/end}}

produces this chart:

Box 1

Box 2

Box 3

Box 4

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

{{tree chart/start}}
{{tree chart| | | | |CLEAR| | | | |CLEAR=Clear box}}
{{tree chart| |,|-|-|'|!|`|-|-|.| }}
{{tree chart|RED  |~|GREEN|~|BLUE |RED=Red box|GREEN=Green box|BLUE=Blue box
|boxstyle_RED  =color:white; background-color: red;
|boxstyle_GREEN=color:yellow; background-color: green;
|boxstyle_BLUE =color:white; background-color: blue;
}}
{{tree chart/end}}

which produces this:

Clear box

Red box

Green box

Blue box

Note: When specifying style attributes for individual named boxes, make sure the box names are aligned to the left side of the 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 chart/start}} template also accepts an optional |style= parameter that can be used to set CSS styles for the entire diagram, and an optional |align= parameter to set the chart alignment.