View source for Template:Chart/doc

<includeonly>{{esoteric}}</includeonly>
<noinclude>{{documentation subpage}}</noinclude>
<!--PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE

    EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE-->

==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 {{tl|chart/start}} and {{tl|chart/end}}. The chart is displayed as [[HTML]] tables using [[Cascading Style Sheets|CSS]] attributes, and may contain arbitrary [[wiki markup]] within the boxes. This implementation was based on the now-deprecated {{tl|familytree}} template.

==Basic example==
This code:
<pre><nowiki>
{{chart/start|summary=An example family tree}}
{{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}}
</nowiki></pre>

produces this:

{{chart/start|summary=An example family tree}}
{{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}}

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.

The {{para|summary|<var>text</var>}} parameter of {{tl|chart/start}} should be used to describe the overall layout of the tree. This summary is for [[Wikipedia:Accessibility|accessibility]]: it is read aloud to visually impaired readers who use [[screen reader]]s, and is invisible to sighted readers.

==Parameters==
The template accepts up to 50 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="float: left; margin-left: 1em;"
|+ '''Solid lines:'''
|-
| {{big|<code>!</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|!}}{{chart/end}} || &nbsp;
| {{big|<code>,</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|,}}{{chart/end}} || &nbsp;
| {{big|<code>v</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|v}}{{chart/end}} || &nbsp;
| {{big|<code>.</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|.}}{{chart/end}} || &nbsp;
|-
| {{big|<code>-</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|-}}{{chart/end}} || &nbsp;
| {{big|<code>)</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|)}}{{chart/end}} || &nbsp;
| {{big|<code>+</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|+}}{{chart/end}} || &nbsp;
| {{big|<code>(</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|(}}{{chart/end}} || &nbsp;
|-
| || ||
| {{big|<code>`</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|`}}{{chart/end}} || &nbsp;
| {{big|<code>^</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|^}}{{chart/end}} || &nbsp;
| {{big|<code>'</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|'}}{{chart/end}} || &nbsp;
|}
{| style="float: left; margin-left: 1em;"
|+ '''Dashed lines:'''
|-
| {{big|<code>:</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|:}}{{chart/end}} || &nbsp;
| {{big|<code>F</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|F}}{{chart/end}} || &nbsp;
| {{big|<code>V</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|V}}{{chart/end}} || &nbsp;
| {{big|<code>7</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|7}}{{chart/end}} || &nbsp;
|-
| {{big|<code>~</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|~}}{{chart/end}} || &nbsp;
| {{big|<code>D</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|D}}{{chart/end}} || &nbsp;
| {{big|<code>%</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|%}}{{chart/end}} || &nbsp;
| {{big|<code>C</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|C}}{{chart/end}} || &nbsp;
|-
| || ||
| {{big|<code>L</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|L}}{{chart/end}} || &nbsp;
| {{big|<code>A</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|A}}{{chart/end}} || &nbsp;
| {{big|<code>J</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|J}}{{chart/end}} || &nbsp;
|}
{| style="float: left; margin-left: 1em;"
|+ '''Dotted lines:'''
|-
| {{big|<code>Q</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|Q}}{{chart/end}} || &nbsp;
| {{big|<code>S</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|S}}{{chart/end}} || &nbsp;
| {{big|<code>M</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|M}}{{chart/end}} || &nbsp;
| {{big|<code>T</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|T}}{{chart/end}} || &nbsp;
|-
| {{big|<code>P</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|P}}{{chart/end}} || &nbsp;
| {{big|<code>H</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|H}}{{chart/end}} || &nbsp;
| {{big|<code>R</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|R}}{{chart/end}} || &nbsp;
| {{big|<code>G</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|G}}{{chart/end}} || &nbsp;
|-
| || ||
| {{big|<code>Y</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|Y}}{{chart/end}} || &nbsp;
| {{big|<code>W</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|W}}{{chart/end}} || &nbsp;
| {{big|<code>Z</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|Z}}{{chart/end}} || &nbsp;
|}
{| style="float: left; margin-left: 1em;"
|+ '''Mixed:'''
|-
| || ||
| {{big|<code>j</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|j}}{{chart/end}} || &nbsp;
| || ||
| || ||
| {{big|<code>y</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|y}}{{chart/end}} || &nbsp;
| || ||
| &nbsp; || &nbsp; || &nbsp;
| || ||
| {{big|<code>r</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|r}}{{chart/end}} || &nbsp;
| || ||
| || ||
| {{big|<code>m</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|m}}{{chart/end}} || &nbsp;
| || ||
| &nbsp; || &nbsp; || &nbsp;
| || ||
| {{big|<code>r2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|r2}}{{chart/end}} || &nbsp;
| || ||
| || ||
| {{big|<code>m2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|m2}}{{chart/end}} || &nbsp;
| || ||
|-
| {{big|<code>d</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|d}}{{chart/end}} || &nbsp;
| {{big|<code>*</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|*}}{{chart/end}} || &nbsp;
| {{big|<code>c</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|c}}{{chart/end}} || &nbsp;
| {{big|<code>f</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|f}}{{chart/end}} || &nbsp;
| {{big|<code>t</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|t}}{{chart/end}} || &nbsp;
| {{big|<code>e</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|e}}{{chart/end}} || &nbsp;
| &nbsp; || &nbsp; || &nbsp;
| {{big|<code>k</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|k}}{{chart/end}} || &nbsp;
| {{big|<code>a</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|a}}{{chart/end}} || &nbsp;
| {{big|<code>l</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|l}}{{chart/end}} || &nbsp;
| {{big|<code>o</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|o}}{{chart/end}} || &nbsp;
| {{big|<code>b</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|b}}{{chart/end}} || &nbsp;
| {{big|<code>p</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|p}}{{chart/end}} || &nbsp;
| &nbsp; || &nbsp; || &nbsp;
| {{big|<code>k2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|k2}}{{chart/end}} || &nbsp;
| {{big|<code>a2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|a2}}{{chart/end}} || &nbsp;
| {{big|<code>l2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|l2}}{{chart/end}} || &nbsp;
| {{big|<code>o2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|o2}}{{chart/end}} || &nbsp;
| {{big|<code>b2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|b2}}{{chart/end}} || &nbsp;
| {{big|<code>p2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|p2}}{{chart/end}} || &nbsp;
|-
| || ||
| {{big|<code>i</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|i}}{{chart/end}} || &nbsp;
| || ||
| || ||
| {{big|<code>h</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|h}}{{chart/end}} || &nbsp;
| || ||
| &nbsp; || &nbsp; || &nbsp;
| || ||
| {{big|<code>q</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|q}}{{chart/end}} || &nbsp;
| || ||
| || ||
| {{big|<code>n</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|n}}{{chart/end}} || &nbsp;
| || ||
| &nbsp; || &nbsp; || &nbsp;
| || ||
| {{big|<code>q2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|q2}}{{chart/end}} || &nbsp;
| || ||
| || ||
| {{big|<code>n2</code>}} || style="border: 1px solid gray;" | {{chart/start}}{{chart|n2}}{{chart/end}} || &nbsp;
| || ||
|}
<br clear="both" />

==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 [[Cascading Style Sheets|CSS]] declarations directly to the box style attributes. For example, the following code:

<pre><nowiki>
{{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}}
</nowiki></pre>

produces this chart:

{{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}}

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

<pre><nowiki>
{{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}}
</nowiki></pre>

which produces this:

{{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}}

{{Warnsign|'''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 "<code>|RED&nbsp;&nbsp;|</code>" instead of "<code>|&nbsp;RED&nbsp;|</code>" in the example above), otherwise the template will end up looking for a style parameter with spaces in its name.

The {{tl|chart/start}} template also accepts an optional ''style'' parameter that can be used to set CSS styles for the entire diagram.

==Migration from familytree==
The {{tl|chart}} template is largely compatible with the earlier {{tl|familytree}} template. However, to use the additional functionality offered with this template, diagrams must be updated to use {{tl|chart}} instead. Many {{tl|familytree}} diagrams can be altered to use {{tl|chart}} and its sub-templates simply by replacing the wikitext <code>familytree</code> with <code>chart</code>. A few of the "mixed" tiles had to be renamed, and {{tl|familytree}} 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:
{| class="notwikitable" style="text-align:center;" border="1" cellspacing="0" cellpadding="3"
!Tile!!{{tl|familytree}}!!{{tl|chart}}
|-
|{{chart/start}}{{chart|c}}{{chart/end}}||<code>{</code>||<code>c</code>
|-
|{{chart/start}}{{chart|d}}{{chart/end}}||<code>}</code>||<code>d</code>
|-
|{{chart/start}}{{chart|t}}{{chart/end}}||<code>#</code>||<code>t</code>
|-
|{{chart/start}}{{chart|e}}{{chart/end}}||<code>[</code>||<code>e</code>
|-
|{{chart/start}}{{chart|f}}{{chart/end}}||<code>]</code>||<code>f</code>
|-
|{{chart/start}}{{chart|i}}{{chart/end}}||&nbsp;||<code>i</code>
|-
|{{chart/start}}{{chart|j}}{{chart/end}}||&nbsp;||<code>j</code>
|}

Lastly, if any uses of the {{tl|familytree}} template end with <code>|}}</code>, 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&nbsp;→&nbsp;Templates" to toggle back to wikitext view. The other templates will be updated to match.

==Errors==
* "{{red|Template:Chart/cellb}}" will be caused by any instance of <code>|}}</code> - change this to <code>| }}</code>.
* "{{red|Template:Chart/celltTemplate:Chart/cellb}}" will be caused by any instance of <code>||</code> - change this to <code>| |</code>, or; <code>|}}</code> - change this to <code>| }}</code>.
* "{{red|Template:Chart/celly tTemplate:Chart/celly b}}"  will be caused by any instance of <code>|y |</code> - change this to <code>|y|</code>.

==See also==
* [[User:GregU/familytree.js|familytree.js]] – tool to easily create or update diagrams using these templates
* [[:Category:Family tree templates]]

<includeonly>
[[Category:Chart formatting templates|{{PAGENAME}}]]

</includeonly>