Template:Tree chart/doc

From Historical Hastings

Usage[edit]

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[edit]

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:

Template:Tree chart/start Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Template:Tree chart/end

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[edit]

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:

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[edit]

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:
! Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   , Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   v Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   . Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end  
- Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   ) Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   + Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   ( Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end  
` Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   ^ Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   ' Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end  
Dashed lines:
: Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   F Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   V Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   7 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end  
~ Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   D Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   % Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   C Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end  
L Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   A Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   J Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end  
Dotted lines:
Q Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   S Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   M Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   T Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end  
P Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   H Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   R Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   G Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end  
Y Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   W Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end   Z Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end  
Dashes hrzntl solid vrtcl:
fy Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end y Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end ye Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
f Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end t Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end e Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
fh Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end h Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end he Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
Solid hrzntl dashes vrtcl:
dj Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end j Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end jc Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
d Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end * Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end c Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
di Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end i Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end ic Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
Solid hrzntl dot vrtcl:
kr Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end r Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end rl Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
k Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end a Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end l Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
kq Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end q Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end ql Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
Dashed hrzntl dot vrtcl:
kr2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end r2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end rl2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
k2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end a2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end l2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
kq2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end q2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end ql2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
Dots hrzntl solid vrtcl:
om Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end m Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end mp Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
o Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end b Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end p Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
on Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end n Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end np Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
Dots hrzntl dashes vrtcl:
om2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end m2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end mp2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
o2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end b2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end p2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
on2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end n2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end np2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
Miscellaneous (grey background not available in, or changed from, familytree):
k3 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end T2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end l3 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end b3 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
G2 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end X Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end K Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end l4 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end
U Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end

Style attributes[edit]

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:

Template:Tree chart/start Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Template:Tree chart/end

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:

Template:Tree chart/start Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Lua error in package.lua at line 80: module 'Module:Tree chart/data' not found. Template:Tree chart/end

Warning sign 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[edit]

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.

Mixed tiles that have changed
Tile {{family tree}} {{tree chart}} Notes on parameters
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end {,3 c Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end },E d Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end # t Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end [ e Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end ] f Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end u j Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end b di Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end c fh Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end d ic Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end j he Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end n ye Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end p om2 Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end q mp2 Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end r kr2 Change
Miscellaneous tiles
Tile {{family tree}} {{tree chart}} Notes on parameters
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end G G2 Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end K K Same
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end T T2 Change
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end U U Same
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end X X Same
Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end 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 Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end with {{tree chart}} (instead use "l4" to generate Template:Tree chart/startLua error in package.lua at line 80: module 'Module:Tree chart/data' not found.Template:Tree chart/end 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.

See also[edit]