Difference between revisions of "Template:Family tree/doc"

From blackwiki
Jump to navigation Jump to search
imported>Verdy p
imported>Eubulides
(Describe summary= parameter, resolving the accessibility issue.)
Line 8: Line 8:
 
==Example usage==
 
==Example usage==
 
This code:
 
This code:
<pre><nowiki>
+
<pre style="overflow:auto;">
{{familytree/start}}
+
{{familytree/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.}}
 
{{familytree | | | | GMa |~|y|~| GPa | | GMa=Grandma|GPa=Grandpa}}
 
{{familytree | | | | GMa |~|y|~| GPa | | GMa=Grandma|GPa=Grandpa}}
 
{{familytree | | | | | | | |)|-|-|-|.| }}
 
{{familytree | | | | | | | |)|-|-|-|.| }}
Line 16: Line 16:
 
{{familytree | JOE | | ME  | | SIS | | | JOE=My brother Joe|ME='''Me!'''|SIS=My little sister}}
 
{{familytree | JOE | | ME  | | SIS | | | JOE=My brother Joe|ME='''Me!'''|SIS=My little sister}}
 
{{familytree/end}}
 
{{familytree/end}}
</nowiki></pre>
+
</pre>
 
Produces this:
 
Produces this:
  
{{familytree/start}}
+
{{familytree/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.}}
 
{{familytree | | | | GMa |~|y|~| GPa | | GMa=Grandma|GPa=Grandpa}}
 
{{familytree | | | | GMa |~|y|~| GPa | | GMa=Grandma|GPa=Grandpa}}
 
{{familytree | | | | | | | |)|-|-|-|.| }}
 
{{familytree | | | | | | | |)|-|-|-|.| }}
Line 28: Line 28:
  
 
== Parameters ==
 
== Parameters ==
This 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'''.
+
The {{para|summary|<var>text</var>}} parameter of the {{tl|familytree/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|familytree}} 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.
 
* '''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.
  
Line 125: Line 127:
 
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:
 
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:
  
<pre><nowiki>
+
<pre style="overflow:auto;">
{{familytree/start}}
+
{{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;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}}
 
{{familytree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }}
 
{{familytree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }}
Line 135: Line 137:
 
produces a result like this:
 
produces a result like this:
  
{{familytree/start}}
+
{{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;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}}
 
{{familytree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }}
 
{{familytree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }}
Line 143: Line 145:
 
Style attributes can even be set for individual boxes, as in the example below:
 
Style attributes can even be set for individual boxes, as in the example below:
  
<pre><nowiki>
+
<pre style="overflow:auto;">
{{familytree/start}}
+
{{familytree/start |White box with three children Red box, Green box, Blue box, all married to each other}}
 
{{familytree| | | | |WHITE| | | | |WHITE=White box}}
 
{{familytree| | | | |WHITE| | | | |WHITE=White box}}
 
{{familytree| |,|-|-|'|!|`|-|-|.| }}
 
{{familytree| |,|-|-|'|!|`|-|-|.| }}
Line 153: Line 155:
 
}}
 
}}
 
{{familytree/end}}
 
{{familytree/end}}
</nowiki></pre>
+
</pre>
  
 
which produces the output:
 
which produces the output:
  
{{familytree/start}}
+
{{familytree/start |White box with three children Red box, Green box, Blue box, all married to each other}}
 
{{familytree| | | | |WHITE| | | | |WHITE=White box}}
 
{{familytree| | | | |WHITE| | | | |WHITE=White box}}
 
{{familytree| |,|-|-|'|!|`|-|-|.| }}
 
{{familytree| |,|-|-|'|!|`|-|-|.| }}
Line 170: Line 172:
  
 
The {{tl|familytree/start}} template also accepts an optional ''style'' parameter that can be used to set CSS styles for the entire table.
 
The {{tl|familytree/start}} template also accepts an optional ''style'' parameter that can be used to set CSS styles for the entire table.
 
==Accessibility==
 
{{AccessibilityDispute}}
 
This template has [[Wikipedia:Accessibility|accessibility]] problems for [[screen reader]] users. The relationships between boxes (the lines) will be hidden, effectively reducing the chart to a series of paragraphs in order by row. Charts with each generation on separate rows (rather than in columns) should be a bit more accessible. It is also recommended that you add a <code>summary</code> parameter to the start tag to describe the overall layout of the table. For example:
 
 
<code><nowiki>{{familytree/start| summary=Family tree diagram for Barack Obama, connecting 29 individuals in 4 generations.  Generations are arranged in rows, with Barack appearing 3rd on the 3rd such row. The bottom right corner breaks out some additional relationships of his father.}}</nowiki></code>
 
  
 
==See also==
 
==See also==

Revision as of 19:49, 30 November 2009

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

Example usage

This code:

{{familytree/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.}}
{{familytree | | | | GMa |~|y|~| GPa | | GMa=Grandma|GPa=Grandpa}}
{{familytree | | | | | | | |)|-|-|-|.| }}
{{familytree | | | MOM |y| DAD | |DAISY| MOM=Mom|DAD=Dad|DAISY=[[Aunt Daisy]]}}
{{familytree | |,|-|-|-|+|-|-|-|.| | | }}
{{familytree | JOE | | ME  | | SIS | | | JOE=My brother Joe|ME='''Me!'''|SIS=My little sister}}
{{familytree/end}}

Produces this:

  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart
  4. REDIRECT Template:Tree chart
  5. REDIRECT Template:Tree chart
  6. REDIRECT Template:Tree chart
  7. REDIRECT Template:Tree chart/end

Parameters

The |summary=text parameter of the {{familytree/start}} template should be used to describe the overall layout of the tree. This summary is for accessibility: it is read aloud to visually impaired readers who use screen readers, and is invisible to sighted readers.

The {{familytree}} 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.
Solid lines:
,
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
v
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
.
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
)
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
+
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
(
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
`
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
^
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
'
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
-
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
!
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
Dashed lines:
F
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
V
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
7
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
D
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
%
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
C
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
L
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
A
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
J
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
~
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
:
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
Mixed (1):
r
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
y
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
n
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
]
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
#
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
[
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
c
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
h
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
j
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
~
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
!
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
Mixed (2):
p
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
u
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
q
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
}
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
*
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
{
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
b
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
t
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
d
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
-
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
:
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
Misc.:
T
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
G
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
X
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
K
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end
k
  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart/end


  • 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 CSS declarations directly to the box style attributes. For example, the following code:

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

produces a result like this:

  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart
  4. REDIRECT Template:Tree chart
  5. REDIRECT Template:Tree chart/end

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

{{familytree/start |White box with three children Red box, Green box, Blue box, all married to each other}}
{{familytree| | | | |WHITE| | | | |WHITE=White box}}
{{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}}

which produces the output:

  1. REDIRECT Template:Tree chart/start
  2. REDIRECT Template:Tree chart
  3. REDIRECT Template:Tree chart
  4. REDIRECT Template:Tree chart
  5. REDIRECT Template:Tree chart/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 "|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 {{familytree/start}} template also accepts an optional style parameter that can be used to set CSS styles for the entire table.

See also