வார்ப்புரு:Tree chart/doc

This template uses Lua:

Module:Tree chart

Not to be confused with Template:Graph:Chart.

This is a documentation subpage for வார்ப்புரு:Tree chart.
It contains usage information, categories and other content that is not part of the original வார்ப்புரு page.

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. This implementation was based on the now-deprecated {{family tree}} template.

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 10 columns as shown below.

The table structure created using the example above

Collapsible basic example

This code uses {{chart top}}:

{{chart top|An example family tree}}
{{Tree chart/start|align=center}}
{{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}}
{{chart bottom}}

produces this: வார்ப்புரு:Chart top

Grandma

Grandpa

Mom

Dad

Aunt Daisy

My brother Joe

Me!

My little sister

வார்ப்புரு:Chart bottom

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.

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.

!

||

,

||

v

||

.

||

-

||

)

||

+

||

(

||

`

||

^

||

'

||

:

||

F

||

V

||

7

||

~

||

D

||

%

||

C

||

L

||

A

||

J

||

Q

||

S

||

M

||

T

||

P

||

H

||

R

||

G

||

Y

||

W

||

Z

||

fy

y

ye

f

t

e

fh

h

he

dj

j

jc

d

*

c

di

i

ic

kr

r

rl

k

a

l

kq

q

ql

kr2

r2

rl2

k2

a2

l2

kq2

q2

ql2

om

m

mp

o

b

p

on

n

np

om2

m2

mp2

o2

b2

p2

on2

n2

np2

k3

T2

l3

b3

G2

X

K

l4

U

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; color: #202122; | | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}}
{{Tree chart| | |,|-|^|-|.| | }}
{{Tree chart|border=3|boxstyle=background:yellow; color: #202122; | | 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.

Migration from familytree

The {{tree chart}} template is largely compatible with the earlier {{family tree}} template. However, to use the additional functionality offered with this template, diagrams must be updated to use {{tree chart}} instead. Many {{family tree}} diagrams can be altered to use {{tree chart}} simply by replacing the wikitext familytree with tree chart. A few of the "mixed" tiles had to be renamed, and {{family tree}} diagrams using these tiles will have to make a few changes. Additionally, three "miscellaneous" tiles have been included in this list that have not changed K,U,X.

Tile {{family tree}} {{tree chart}} Notes on parameters

||{,3||c||Change

||},E||d||Change

||#||t||Change

||[||e||Change

||]||f||Change

||t||i||Change

||u||j||Change

||b||di||Change

||c||fh||Change

||d||ic||Change

||j||he||Change

||n||ye||Change

||p||dj||Change

||q||jc||Change

||r||fy||Change

Tile {{family tree}} {{tree chart}} Notes on parameters

||G||G2||Change

||K||K||Same

||T||T2||Change

||U||U||Same

||X||X||Same

||k||l4||Change

When converting from {{familytree}} to {{tree chart}} care must be taken with all the glyph mentioned in this section to generate tiles with {{familytree}} are altered so that the tiles are not silently replaced with inappropriate tiles from {{tree chart}}.

For example: the glyph "k" generates the tile

with {{Familytree}}

but

with {{tree chart}}

(instead use "l4" to generate

with {{tree chart}}).

Lastly, if any uses of the {{family tree}} template end with |}}, that vertical bar should be removed, leaving the last cell in that row containing either some text or a space.

The familytree.js tool below can be used to convert between syntaxes. Just change the start tag when in edit view, then click "Art → Templates" to toggle back to wikitext view. The other templates will be updated to match.