Difference between revisions of "Template:Chart"

Template documentation[view] [edit] [history] [purge]

Uses Lua: Module:TreeChart

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 {{chart/start}} and {{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:

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

produces this:

This charts 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 parent's had another child, Aunt Daisy.

Collapsible basic example

This code:

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

produces this:

This charts 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 parent's 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.

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:

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

produces this chart:

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

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

which produces this:

 '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 {{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 {{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 {{chart}} instead. Many {{family tree}} diagrams can be altered to use {{chart}} simply by replacing the wikitext familytree with 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, two new "mixed" tiles have been added, joining solid lines to dashed lines. The following table summarises the differences:

The following list of tiles exist in {{Familytree}}, but do not exist in {{Chart}}. When converting from {{Familytree}} to {{Chart}} care must be taken to alter the tree so that these tiles are not used.

When converting from {{Familytree}} to {{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 {{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

• familytree.js, a tool for the easy creation or updating of diagrams using these templates.
• Category:Family tree templates
• Template:Nerva–Antonine family tree, a large example.