Template

Chart/doc

From Children of StarClan

< Template:Chart

This is a template for rendering simple diagrams consisting of boxes and connecting lines based loosely 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. This implementation was based on the {{familytree}} template.

Example usage

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:

Grandma
Grandpa
Mom
Dad
Bloodstar
My brother Joe
Me!
My little sister

Parameters

This template produces one row in a family tree table. The template accepts up to 50 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 one- or two-character symbols: for the most common tiles, that character is 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 available tiles is given below.


Basic Parameters
Mixed Parameters


  • 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.
  • CoSC Conventions for usages are as follows:
    • Matings are denoted by dashed lines.
    • Biological Offspring are denoted by solid lines.
    • Adoptions are denoted by dotted lines (which are used to fill in the places where solid line connections would be placed).

Style attributes

The appearance of the boxes 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=0|boxstyle=background:#dfd;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}}
{{chart|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }}
{{chart|border=0|boxstyle=background:#dfd;| | FOO | | BAR | |FOO=Box 3|BAR=Box 4}}
{{chart/end}}

produces this chart:

Box 1
Box 2
Box 3
Box 4

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

{{chart/start}}
{{chart| | | | |WHITE| | | | |WHITE=White box}}
{{chart| |,|-|-|'|!|`|-|-|.| }}
{{chart|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;
}}
{{chart/end}}

which produces this:

White box
Red box
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 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.