doc

Revision as of 14:27, 3 February 2009

Template:documentation subpage 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 Template:tl 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

Aunt Daisy

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.

,

Template:chart/cell,t Template:chart/cell,b

.

Template:chart/cell.b

`

Template:chart/cell`t Template:chart/cell`b

'

Template:chart/cell't Template:chart/cell'b

^

Template:chart/cell^t Template:chart/cell^b

v

Template:chart/cellvt Template:chart/cellvb

(

Template:chart/cell(t Template:chart/cell(b

)

Template:chart/cell)t Template:chart/cell)b

-

Template:chart/cell-t Template:chart/cell-b

!

Template:chart/cell!t Template:chart/cell!b

+

Template:chart/cell+t Template:chart/cell+b

F

Template:chart/cellFt Template:chart/cellFb

7

Template:chart/cell7t Template:chart/cell7b

L

Template:chart/cellLt Template:chart/cellLb

J

Template:chart/cellJt Template:chart/cellJb

A

Template:chart/cellAt Template:chart/cellAb

V

Template:chart/cellVt Template:chart/cellVb

C

Template:chart/cellCt Template:chart/cellCb

D

Template:chart/cellDt Template:chart/cellDb

~

:

Template:chart/cell:t Template:chart/cell:b

%

Template:chart/cell%t Template:chart/cell%b

S

Template:chart/cellSt Template:chart/cellSb

T

Template:chart/cellTt Template:chart/cellTb

Y

Template:chart/cellYt Template:chart/cellYb

Z

Template:chart/cellZt Template:chart/cellZb

W

Template:chart/cellWt Template:chart/cellWb

M

Template:chart/cellMt Template:chart/cellMb

G

Template:chart/cellGt Template:chart/cellGb

H

Template:chart/cellHt Template:chart/cellHb

P

Template:chart/cellPt Template:chart/cellPb

Q

Template:chart/cellQt Template:chart/cellQb

R

Template:chart/cellRt Template:chart/cellRb

*

Template:chart/cell*t Template:chart/cell*b

d

Template:chart/celldt Template:chart/celldb

c

Template:chart/cellct Template:chart/cellcb

a

Template:chart/cellat Template:chart/cellab

k

Template:chart/cellkt Template:chart/cellkb

l

Template:chart/celllt Template:chart/celllb

a2

Template:chart/cella2t Template:chart/cella2b

k2

Template:chart/cellk2t Template:chart/cellk2b

l2

Template:chart/celll2t Template:chart/celll2b

t

Template:chart/celltt Template:chart/celltb

y

h

Template:chart/cellht Template:chart/cellhb

b

Template:chart/cellbt Template:chart/cellbb

m

Template:chart/cellmt Template:chart/cellmb

n

Template:chart/cellnt Template:chart/cellnb

b2

Template:chart/cellb2t Template:chart/cellb2b

m2

Template:chart/cellm2t Template:chart/cellm2b

n2

Template:chart/celln2t Template:chart/celln2b

f

Template:chart/cellft Template:chart/cellfb

e

Template:chart/cellet Template:chart/celleb

i

Template:chart/cellit Template:chart/cellib

j

Template:chart/celljt Template:chart/celljb

o

Template:chart/cellot Template:chart/cellob

p

Template:chart/cellpt Template:chart/cellpb

q

Template:chart/cellqt Template:chart/cellqb

r

Template:chart/cellrt Template:chart/cellrb

o2

Template:chart/cello2t Template:chart/cello2b

p2

Template:chart/cellp2t Template:chart/cellp2b

q2

Template:chart/cellq2t

r2

Template:chart/cellr2t Template:chart/cellr2b

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.

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:

Template:chart/cell,t Template:chart/cell-t Template:chart/cell^t Template:chart/cell-t Template:chart/cell,b Template:chart/cell-b Template:chart/cell^b Template:chart/cell-b Template:chart/cell.b

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| | | | |CLEAR| | | | |CLEAR=Clear 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:

Template:chart/cell,t Template:chart/cell-t Template:chart/cell-t Template:chart/cell't Template:chart/cell!t Template:chart/cell`t Template:chart/cell-t Template:chart/cell-t Template:chart/cell,b Template:chart/cell-b Template:chart/cell-b Template:chart/cell'b Template:chart/cell!b Template:chart/cell`b Template:chart/cell-b Template:chart/cell-b Template:chart/cell.b

Clear 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 Template:tl template also accepts an optional style parameter that can be used to set CSS styles for the entire diagram.

Migration from familytree

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

Tile Template:tl Template:tl

Template:chart/cellct Template:chart/cellcb

{

c

Template:chart/celldt Template:chart/celldb

}

d

Template:chart/celltt Template:chart/celltb

#

t

Template:chart/cellet Template:chart/celleb

[

e

Template:chart/cellft Template:chart/cellfb

]

f

Template:chart/cellit Template:chart/cellib

i

Template:chart/celljt Template:chart/celljb

j

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

Errors

Template:Chart/cellb will be caused by any instance of |}} change this to }}

Template:Chart/celltTemplate:Chart/cellb will be caused by any instance of || change this to | |

doc

Revision as of 14:27, 3 February 2009

Contents

Example usage

Parameters

Style attributes

Migration from familytree

Errors

Navigation menu

Revision as of 10:41, 23 January 2009 (view source) *>Gadget850 (→‎Migration from familytree: errors)	Revision as of 14:27, 3 February 2009 (view source) Eric (talk \| contribs) (New page: <includeonly>{{esoteric}}{{template doc page transcluded}}</includeonly> <noinclude>{{documentation subpage}}</noinclude> <!--PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM...) Newer edit →
(No difference)

doc

Revision as of 14:27, 3 February 2009

Example usage

Parameters

Style attributes

Migration from familytree

Errors

Navigation menu

Search