Difference between revisions of "Chart/doc"

Revision as of 21:47, 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:

Grandma

Grandpa

Mom

Dad

Bloodstar

My brother Joe

Me!

My little sister

Parameters

,

.

`

'

^

v

(

)

-

!

+

F

7

L

J

A

V

C

D

~

:

%

S

T

Y

Z

W

M

G

H

P

Q

R

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.

@@ Line 2: / Line 2: @@
 ==Example usage==
-This code:
+{{/1}}
-<pre><nowiki>
-{{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}}
-</nowiki></pre>
-Produces this:
-{{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}}
 ==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'''.
+{{/2}}
-*'''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.
-{| style="float: left; margin-left: 1em;"
-|+ '''Solid lines:'''
-|-
-| <big><tt>,</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|,}}{{chart/end}} || &nbsp;
-| <big><tt>.</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|.}}{{chart/end}} || &nbsp;
-| <big><tt>`</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|`}}{{chart/end}} || &nbsp;
-| <big><tt>'</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|'}}{{chart/end}} || &nbsp;
-|-
-| <big><tt>^</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|^}}{{chart/end}} || &nbsp;
-| <big><tt>v</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|v}}{{chart/end}} || &nbsp;
-| <big><tt>(</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|(}}{{chart/end}} || &nbsp;
-| <big><tt>)</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|)}}{{chart/end}} || &nbsp;
-|-
-| <big><tt>-</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|-}}{{chart/end}} || &nbsp;
-| <big><tt>!</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|!}}{{chart/end}} || &nbsp;
-| <big><tt>+</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|+}}{{chart/end}} || &nbsp;
-| <big><tt> </tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart| }}{{chart/end}} || &nbsp;
-|}
-{| style="float: left; margin-left: 1em;"
-|+ '''Dashed lines:'''
-|-
-| <big><tt>F</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|F}}{{chart/end}} || &nbsp;
-| <big><tt>7</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|7}}{{chart/end}} || &nbsp;
-| <big><tt>L</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|L}}{{chart/end}} || &nbsp;
-| <big><tt>J</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|J}}{{chart/end}} || &nbsp;
-|-
-| <big><tt>A</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|A}}{{chart/end}} || &nbsp;
-| <big><tt>V</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|V}}{{chart/end}} || &nbsp;
-| <big><tt>C</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|C}}{{chart/end}} || &nbsp;
-| <big><tt>D</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|D}}{{chart/end}} || &nbsp;
-|-
-| <big><tt>~</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|~}}{{chart/end}} || &nbsp;
-| <big><tt>:</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|:}}{{chart/end}} || &nbsp;
-| <big><tt>%</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|%}}{{chart/end}} || &nbsp;
-| <big><tt> </tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart| }}{{chart/end}} || &nbsp;
-|}
-{| style="float: left; margin-left: 1em;"
-|+ '''Dotted lines:'''
-|-
-| <big><tt>S</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|S}}{{chart/end}} || &nbsp;
-| <big><tt>T</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|T}}{{chart/end}} || &nbsp;
-| <big><tt>Y</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|Y}}{{chart/end}} || &nbsp;
-| <big><tt>Z</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|Z}}{{chart/end}} || &nbsp;
-|-
-| <big><tt>W</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|W}}{{chart/end}} || &nbsp;
-| <big><tt>M</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|M}}{{chart/end}} || &nbsp;
-| <big><tt>G</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|G}}{{chart/end}} || &nbsp;
-| <big><tt>H</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|H}}{{chart/end}} || &nbsp;
-|-
-| <big><tt>P</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|P}}{{chart/end}} || &nbsp;
-| <big><tt>Q</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|Q}}{{chart/end}} || &nbsp;
-| <big><tt>R</tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart|R}}{{chart/end}} || &nbsp;
-| <big><tt> </tt></big> || style="border: 1px solid gray;" | {{chart/start}}{{chart| }}{{chart/end}} || &nbsp;
-|}
-=== Mixed Lines ===
 ==Style attributes==

Template

Difference between revisions of "Chart/doc"

From Children of StarClan

< Template:Chart

Revision as of 21:47, 5 August 2008

Example usage

Parameters

Style attributes