Difference between revisions of "Chart/doc"

Revision as of 20:22, 5 August 2008

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:

Parameters

This template produces one row in a family tree table. The template accepts up to 40 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.

Solid Lines

Dashed Lines

Dotted Lines

Mixed Lines

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:

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:

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.

Migration from familytree

The {{chart}} template is largely compatible with the earlier {{familytree}} template. However, to use the additional functionality offered with this template, diagrams must be updated to use {{chart}} instead. Many {{familytree}} diagrams can be altered to use {{chart}} and its sub-templates simply by replacing the wikitext familytree with chart. A few of the "mixed" tiles had to be renamed, and {{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:

Lastly, if any uses of the {{familytree}} template end with |}}, that vertical bar should be removed, leaving the last cell in that row containing either some text or a space.