View source for Template:Family tree/doc

<includeonly>{{Deprecated template|Family tree|Tree chart|date=October 2013|note=The new template provides all the features of the old one and more. Its usage is very similar but there are minor differences. For help with migration see [[Template:Chart#Migration_from_familytree|Template:Tree chart#Migration from familytree]].}}
{{Intricate template}}{{Documentation subpage}}</includeonly>
<noinclude>{{Documentation subpage}}</noinclude>
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE

     EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE--->
{{ombox
| image = [[File:Edit-copy purple-wikit.svg|40px]]
| type  = move
| text  = When editing extremely large diagram with Family tree it is possible that you would be unable to submit the content due to [[Wikipedia:template limits]].  In that case please consider migrating your diagram to {{tl|Tree chart}} which generates lower preprocessor node count.
}}

This is a template for rendering simple [[family tree]]s consisting of boxes and connecting lines based on an [[ASCII art]]-like syntax.  The trees are displayed as [[HTML]] tables using [[Cascading Style Sheets|CSS]] attributes, and may contain arbitrary [[wiki markup]] within the boxes.

{{red|''This template is now [[deprecated]]. For new family trees use the similar {{tlx|Tree chart}} template''}}

==Example usage==
This code:
<source lang="moin" style="overflow:auto;">
{{family tree/start |summary=I have a brother Joe and a little sister: my mom married my dad, and my dad's parents were Grandma and Grandpa; they had another child, Aunt Daisy.}}
{{family tree | | | | GMa |~|y|~| GPa | | GMa=Gladys|GPa=Sydney}}
{{family tree | | | | | | | |)|-|-|-|.| }}
{{family tree | | | MOM |y| DAD | |DAISY| MOM=Mom|DAD=Dad|DAISY=[[Aunt Daisy]]}}
{{family tree | |,|-|-|-|+|-|-|-|.| | | }}
{{family tree | JOE | | ME  | | SIS | | | JOE=My brother Joe|ME='''Me!'''|SIS=My little sister}}
{{family tree/end}}
</source>
Produces this:

{{family tree/start |summary=I have a brother Joe and a little sister: my mom married my dad, and my dad's parents were Grandma and Grandpa; they had another child, Aunt Daisy.}}
{{family tree | | | | GMa |~|y|~| GPa | | GMa=Gladys|GPa=Sydney}}
{{family tree | | | | | | | |)|-|-|-|.| }}
{{family tree | | | MOM |y| DAD | |DAISY| MOM=Mom|DAD=Dad|DAISY=[[Aunt Daisy]]}}
{{family tree | |,|-|-|-|+|-|-|-|.| | | }}
{{family tree | JOE | | ME  | | SIS | | | JOE=My brother Joe|ME='''Me!'''|SIS=My little sister}}
{{family tree/end}}

== Parameters ==
The {{para|summary|<var>text</var>}} parameter of the {{tl|family tree/start}} template 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.

The {{tl|family tree}} template produces one row in a family tree table.  The template accepts up to 80 unnamed parameters describing the contents of the table.  Each parameter specifies a '''tile''' or a '''box'''.
* '''Tiles''' are line drawing symbols consisting of horizontal and vertical lines and various corners and crossings thereof.  Tiles are specified using single-character symbols that more or less approximate the shape of the tile in appearance.  A special case of a tile is the '''empty tile''', specified by a single space character.  A table of supported tiles is given below.

{|style="float:left;margin-left:1em"
|+ '''Solid lines:'''
|-
| {{big|<code>,</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|,}}{{family tree/end}}
| {{big|<code>v</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|v}}{{family tree/end}}
| {{big|<code>.</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|.}}{{family tree/end}}
|-
| {{big|<code>)</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|)}}{{family tree/end}}
| {{big|<code>+</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|+}}{{family tree/end}}
| {{big|<code>(</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|(}}{{family tree/end}}
|-
| {{big|<code>`</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|`}}{{family tree/end}}
| {{big|<code>^</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|^}}{{family tree/end}}
| {{big|<code>'</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|'}}{{family tree/end}}
|-
| {{big|<code>-</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|-}}{{family tree/end}}
| {{big|<code>!</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|!}}{{family tree/end}}
| {{big|<code> </code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree| }}{{family tree/end}}
|}
{| style="float:left;margin-left:1em"
|+ '''Dashed lines:'''
|-
| {{big|<code>F</code>}} ||style="border:1px solid gray"| {{family tree/start}}{{family tree|F}}{{family tree/end}}
| {{big|<code>V</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|V}}{{familytree/end}}
| {{big|<code>7</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|7}}{{familytree/end}}
|-
| {{big|<code>D</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|D}}{{familytree/end}}
| {{big|<code>%</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|%}}{{familytree/end}}
| {{big|<code>C</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|C}}{{familytree/end}}
|-
| {{big|<code>L</code>}} ||style="border: 1px solid gray"| {{familytree/start}}{{familytree|L}}{{familytree/end}}
| {{big|<code>A</code>}} ||style="border: 1px solid gray"| {{familytree/start}}{{familytree|A}}{{familytree/end}}
| {{big|<code>J</code>}} ||style="border: 1px solid gray"| {{familytree/start}}{{familytree|J}}{{familytree/end}}
|-
| {{big|<code>~</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|~}}{{familytree/end}}
| {{big|<code>:</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|:}}{{familytree/end}}
| {{big|<code> </code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree| }}{{familytree/end}}
|}
{|style="float:left;margin-left:1em"
|+ '''Mixed (1):'''
|-
| {{big|<code>r</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|r}}{{familytree/end}}
| {{big|<code>y</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|y}}{{familytree/end}}
| {{big|<code>n</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|n}}{{familytree/end}}
|-
| {{big|<code>]</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|]}}{{familytree/end}}
| {{big|<code>#</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|#}}{{familytree/end}}
| {{big|<code>[</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|[}}{{familytree/end}}
|-
| {{big|<code>c</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|c}}{{familytree/end}}
| {{big|<code>h</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|h}}{{familytree/end}}
| {{big|<code>j</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|j}}{{familytree/end}}
|-
| {{big|<code>~</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|~}}{{familytree/end}}
| {{big|<code>!</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|!}}{{familytree/end}}
| {{big|<code> </code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree| }}{{familytree/end}}
|}
{|style="float:left;margin-left:1em"
|+ '''Mixed (2):'''
|-
| {{big|<code>p</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|p}}{{familytree/end}}
| {{big|<code>u</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|u}}{{familytree/end}}
| {{big|<code>q</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|q}}{{familytree/end}}
|-
| {{big|<code>E</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|E|}}{{familytree/end}}
| {{big|<code>*</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|*}}{{familytree/end}}
| {{big|<code>3</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|3|}}{{familytree/end}}
|-
| {{big|<code>b</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|b}}{{familytree/end}}
| {{big|<code>t</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|t|}}{{familytree/end}}
| {{big|<code>d</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|d}}{{familytree/end}}
|-
| {{big|<code>-</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|-}}{{familytree/end}}
| {{big|<code>:</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|:}}{{familytree/end}}
| {{big|<code> </code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree| }}{{familytree/end}}
|}
{|style="float:left;margin-left:1em"
|+ '''Misc.:'''<!-- this subset is an insufficient set or questionable: -->
|-
| ||
| {{big|<code>T</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|T}}{{familytree/end}}
|-
| {{big|<code>G</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|G}}{{familytree/end}}
| {{big|<code>X</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|X}}{{familytree/end}}
| {{big|<code>K</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|K}}{{familytree/end}}
| {{big|<code>k</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|k}}{{familytree/end}}
|-
| ||
| {{big|<code>U</code>}} ||style="border:1px solid gray"| {{familytree/start}}{{familytree|U}}{{familytree/end}}
|}
{{clear left}}
* '''Boxes''' can contain arbitrary [[wiki markup]].  The contents of boxes are specified using additional named parameters appended to the template call.  Each box is '''three tiles wide''' and normally has a 2 pixels wide black border.  Boxes can have any name that is a valid template parameter name, although single character names should be avoided to prevent conflicts with tile symbols.

==Style attributes==

The appearance of the boxes may be controlled by the optional template parameters ''border'' and ''boxstyle''.  The former sets the width of the box border in pixels, while the latter can be used to append arbitrary [[Cascading Style Sheets|CSS]] declarations directly to the box style attributes.  For example, the following code:

<source lang="css" style="overflow:auto;">
{{familytree/start |summary=Box 1 married to Box 2, with children Box 3 and Box 4}}
{{familytree|border=0|boxstyle=background:#dfd;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}}
{{familytree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }}
{{familytree|border=0|boxstyle=background:#dfd;| | FOO | | BAR | |FOO=Box 3|BAR=Box 4}}
{{familytree/end}}
</source>

produces a result like this:

{{familytree/start |summary=Box 1 married to Box 2, with children Box 3 and Box 4}}
{{familytree|border=0|boxstyle=background:#dfd;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}}
{{familytree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }}
{{familytree|border=0|boxstyle=background:#dfd;| | FOO | | BAR | |FOO=Box 3|BAR=Box 4}}
{{familytree/end}}

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

<source lang="css" style="overflow:auto;">
{{familytree/start |White box with three children Red box, Green box, Blue box, all married to each other}}
{{familytree| | | | |WHITE| | | | |WHITE=White box
|boxstyle_WHITE = background-color: #fff;
}}
{{familytree| |,|-|-|'|!|`|-|-|.| }}
{{familytree|RED  |~|GREEN|~|BLUE |RED=Red box|GREEN=Green box|BLUE=Blue box
|boxstyle_RED   = background-color: #faa;
|boxstyle_GREEN = background-color: #afa;
|boxstyle_BLUE  = background-color: #aaf;
}}
{{familytree/end}}
</source>

which produces the output:

{{familytree/start |White box with three children Red box, Green box, Blue box, all married to each other}}
{{familytree| | | | |WHITE| | | | |WHITE=White box
|boxstyle_WHITE = background-color: #fff;
}}
{{familytree| |,|-|-|'|!|`|-|-|.| }}
{{familytree|RED  |~|GREEN|~|BLUE |RED=Red box|GREEN=Green box|BLUE=Blue box
|boxstyle_RED  =background-color: #faa;
|boxstyle_GREEN=background-color: #afa;
|boxstyle_BLUE =background-color: #aaf;
}}
{{familytree/end}}

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

== See also ==
* [[Wikipedia:Family trees]] for other methods.
* {{tl|chart}}, which supports more complex family trees.
* [[User:GregU/familytree.js|familytree.js]], a tool aiding the creation or updating of diagrams using these templates.
* {{cl|Family tree templates}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
[[Category:Genealogy formatting templates]]
[[Category:Family tree templates|*]]
}}</includeonly>