Difference between revisions of "Template:Family tree"
Line 370: | Line 370: | ||
* '''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. | * '''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== | ||
− | [[Category:Template]] | + | 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: |
+ | |||
+ | |||
+ | <nowiki> | ||
+ | {{family tree/start |summary=Box 1 married to Box 2, with children Box 3 and Box 4}} | ||
+ | {{family tree|border=0|boxstyle=background:#dfd;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}} | ||
+ | {{family tree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }} | ||
+ | {{family tree|border=0|boxstyle=background:#dfd;| | FOO | | BAR | |FOO=Box 3|BAR=Box 4}} | ||
+ | {{family tree/end}}</nowiki> | ||
+ | |||
+ | produces a result like this: | ||
+ | |||
+ | {{family tree/start |summary=Box 1 married to Box 2, with children Box 3 and Box 4}} | ||
+ | {{family tree|border=0|boxstyle=background:#dfd;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}} | ||
+ | {{family tree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }} | ||
+ | {{family tree|border=0|boxstyle=background:#dfd;| | FOO | | BAR | |FOO=Box 3|BAR=Box 4}} | ||
+ | {{family tree/end}} | ||
+ | |||
+ | Style attributes can even be set for individual boxes, as in the example below & the <nowiki>{{family tree/start}}</nowiki> 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 alignment of the whole table on the page. *Note: can't currently get text align to work in the style parameter... | ||
+ | |||
+ | |||
+ | <nowiki> | ||
+ | {{family tree/start |align=center|style=color: red; font-size: 150%;|summary=White box with three children Red box, Green box, Blue box, all married to each other}} | ||
+ | {{family tree| | | | |WHITE| | | | |WHITE=White box | ||
+ | |boxstyle_WHITE = background-color: #fff; | ||
+ | }} | ||
+ | {{family tree| |,|-|-|'|!|`|-|-|.| }} | ||
+ | {{family tree|RED |~|GREEN|~|BLUE |RED=Text for Red box <br>more text <br> something else|GREEN=Green box|BLUE=Blue box | ||
+ | |boxstyle_RED =background-color: #faa; | ||
+ | |boxstyle_GREEN=background-color: #afa; | ||
+ | |boxstyle_BLUE =background-color: #aaf; | ||
+ | }} | ||
+ | {{family tree/end}}</nowiki> | ||
+ | |||
+ | which produces the output: | ||
+ | {{family tree/start |align=center|style=color: red; font-size: 150%;|summary=White box with three children Red box, Green box, Blue box, all married to each other}} | ||
+ | {{family tree| | | | |WHITE| | | | |WHITE=White box | ||
+ | |boxstyle_WHITE = background-color: #fff; | ||
+ | }} | ||
+ | {{family tree| |,|-|-|'|!|`|-|-|.| }} | ||
+ | {{family tree|RED |~|GREEN|~|BLUE |RED=Text for Red box <br>more text <br> something else|GREEN=Green box|BLUE=Blue box | ||
+ | |boxstyle_RED =background-color: #faa; | ||
+ | |boxstyle_GREEN=background-color: #afa; | ||
+ | |boxstyle_BLUE =background-color: #aaf; | ||
+ | }} | ||
+ | {{family tree/end}} | ||
+ | <div style="clear: left;"></div> | ||
+ | '''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 |</code>" instead of "<code>| RED |</code>" in the example above). Otherwise the template will end up looking for a style parameter with spaces in its name. | ||
+ | |||
+ | |||
+ | [[Category:Formatting Template]] | ||
</noinclude> | </noinclude> |
Latest revision as of 06:48, 20 July 2019
Documentation
This is a template for rendering simple family trees or diagrams consisting of boxes and connecting lines based on an ASCII art-like syntax. The trees are displayed as HTML tables using Cascading Style Sheets attributes, and may contain arbitrary wiki markup within the boxes.
Example usage
This code:
{{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}}
Produces this:
Gladys | Sydney | ||||||||||||||||||||||||
Mom | Dad | Aunt Daisy | |||||||||||||||||||||||
My brother Joe | Me! | My little sister | |||||||||||||||||||||||
Table Set Up
The summary in {{Family tree/start|summary=TEXT HERE}} appears as tool-tip text when the user hovers over the table, it should contain a general description of the table contents. {{Family tree/start}} also provides the formatting to begin the table.
The {{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.
{{Family tree/end}} simply provides the end </table> for the table.
Parameters
- 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.
, |
|
v |
|
. |
| ||||||||||||
) |
|
+ |
|
( |
| ||||||||||||
` |
|
^ |
|
' |
| ||||||||||||
- |
|
! |
|
|
|
F |
|
V |
|
7 |
| ||||||||||||
D |
|
% |
|
C |
| ||||||||||||
L |
|
A |
|
J |
| ||||||||||||
~ |
|
: |
|
|
|
r |
|
y |
|
n |
| ||||||||||||
] |
|
# |
|
[ |
| ||||||||||||
c |
|
h |
|
j |
| ||||||||||||
~ |
|
! |
|
|
|
p |
|
u |
|
q |
| ||||||||||||||
E |
|
* |
|
3 |
| ||||||||||||||
b |
|
t |
|
d |
| ||||||||||||||
- |
|
: |
|
|
|
T |
| ||||||||||||||||||||
G |
|
X |
|
K |
|
k |
| ||||||||||||||
U |
|
- 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:
{{family tree/start |summary=Box 1 married to Box 2, with children Box 3 and Box 4}} {{family tree|border=0|boxstyle=background:#dfd;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}} {{family tree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }} {{family tree|border=0|boxstyle=background:#dfd;| | FOO | | BAR | |FOO=Box 3|BAR=Box 4}} {{family tree/end}}
produces a result like this:
Box 1 | Box 2 | ||||||||||||||||
Box 3 | Box 4 | ||||||||||||||||
Style attributes can even be set for individual boxes, as in the example below & the {{family tree/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 alignment of the whole table on the page. *Note: can't currently get text align to work in the style parameter...
{{family tree/start |align=center|style=color: red; font-size: 150%;|summary=White box with three children Red box, Green box, Blue box, all married to each other}} {{family tree| | | | |WHITE| | | | |WHITE=White box |boxstyle_WHITE = background-color: #fff; }} {{family tree| |,|-|-|'|!|`|-|-|.| }} {{family tree|RED |~|GREEN|~|BLUE |RED=Text for Red box <br>more text <br> something else|GREEN=Green box|BLUE=Blue box |boxstyle_RED =background-color: #faa; |boxstyle_GREEN=background-color: #afa; |boxstyle_BLUE =background-color: #aaf; }} {{family tree/end}}
which produces the output:
White box | |||||||||||||||||||||
Text for Red box more text something else | Green box | Blue box | |||||||||||||||||||
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.