Palchen Dupa

From Rangjung Yeshe Wiki - Dharma Dictionary
Revision as of 07:39, 9 February 2008 by *>TimR (moved Template:Chart/Start to Template:Chart/start: case)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
[edit] Documentation

Template:esotericTemplate:template doc page transcluded

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:

Template:chart/cell)tTemplate:chart/cell-tTemplate:chart/cell-tTemplate:chart/cell-tTemplate:chart/cell)bTemplate:chart/cell-bTemplate:chart/cell-bTemplate:chart/cell-bTemplate:chart/cell.bTemplate:chart/cell,tTemplate:chart/cell-tTemplate:chart/cell-tTemplate:chart/cell-tTemplate:chart/cell+tTemplate:chart/cell-tTemplate:chart/cell-tTemplate:chart/cell-tTemplate:chart/cell,bTemplate:chart/cell-bTemplate:chart/cell-bTemplate:chart/cell-bTemplate:chart/cell+bTemplate:chart/cell-bTemplate:chart/cell-bTemplate:chart/cell-bTemplate:chart/cell.b
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.
Solid lines:
, Template:chart/cell,tTemplate:chart/cell,b
  . Template:chart/cell.b
  ` Template:chart/cell`tTemplate:chart/cell`b
  ' Template:chart/cell'tTemplate:chart/cell'b
 
^ Template:chart/cell^tTemplate:chart/cell^b
  v Template:chart/cellvtTemplate:chart/cellvb
  ( Template:chart/cell(tTemplate:chart/cell(b
  ) Template:chart/cell)tTemplate:chart/cell)b
 
- Template:chart/cell-tTemplate:chart/cell-b
  ! Template:chart/cell!tTemplate:chart/cell!b
  + Template:chart/cell+tTemplate:chart/cell+b
 
 
Dashed lines:
F Template:chart/cellFtTemplate:chart/cellFb
  7 Template:chart/cell7tTemplate:chart/cell7b
  L Template:chart/cellLtTemplate:chart/cellLb
  J Template:chart/cellJtTemplate:chart/cellJb
 
A Template:chart/cellAtTemplate:chart/cellAb
  V Template:chart/cellVtTemplate:chart/cellVb
  C Template:chart/cellCtTemplate:chart/cellCb
  D Template:chart/cellDtTemplate:chart/cellDb
 
~
  : Template:chart/cell:tTemplate:chart/cell:b
  % Template:chart/cell%tTemplate:chart/cell%b
 
 
Dotted lines:
S Template:chart/cellStTemplate:chart/cellSb
  T Template:chart/cellTtTemplate:chart/cellTb
  Y Template:chart/cellYtTemplate:chart/cellYb
  Z Template:chart/cellZtTemplate:chart/cellZb
 
W Template:chart/cellWtTemplate:chart/cellWb
  M Template:chart/cellMtTemplate:chart/cellMb
  G Template:chart/cellGtTemplate:chart/cellGb
  H Template:chart/cellHtTemplate:chart/cellHb
 
P Template:chart/cellPtTemplate:chart/cellPb
  Q Template:chart/cellQtTemplate:chart/cellQb
  R Template:chart/cellRtTemplate:chart/cellRb
 
 
Mixed:
* Template:chart/cell*tTemplate:chart/cell*b
  d Template:chart/celldtTemplate:chart/celldb
  c Template:chart/cellctTemplate:chart/cellcb
        a Template:chart/cellatTemplate:chart/cellab
  k Template:chart/cellktTemplate:chart/cellkb
  l Template:chart/cellltTemplate:chart/celllb
        a2 Template:chart/cella2tTemplate:chart/cella2b
  k2 Template:chart/cellk2tTemplate:chart/cellk2b
  l2 Template:chart/celll2tTemplate:chart/celll2b
 
t Template:chart/cellttTemplate:chart/celltb
  y
  h Template:chart/cellhtTemplate:chart/cellhb
        b Template:chart/cellbtTemplate:chart/cellbb
  m Template:chart/cellmtTemplate:chart/cellmb
  n Template:chart/cellntTemplate:chart/cellnb
        b2 Template:chart/cellb2tTemplate:chart/cellb2b
  m2 Template:chart/cellm2tTemplate:chart/cellm2b
  n2 Template:chart/celln2tTemplate:chart/celln2b
 
f Template:chart/cellftTemplate:chart/cellfb
  e Template:chart/celletTemplate:chart/celleb
  i Template:chart/cellitTemplate:chart/cellib
  j Template:chart/celljtTemplate:chart/celljb
  o Template:chart/cellotTemplate:chart/cellob
  p Template:chart/cellptTemplate:chart/cellpb
  q Template:chart/cellqtTemplate:chart/cellqb
  r Template:chart/cellrtTemplate:chart/cellrb
  o2 Template:chart/cello2tTemplate:chart/cello2b
  p2 Template:chart/cellp2tTemplate:chart/cellp2b
  q2 Template:chart/cellq2t
  r2 Template:chart/cellr2tTemplate: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,tTemplate:chart/cell-tTemplate:chart/cell^tTemplate:chart/cell-tTemplate:chart/cell,bTemplate:chart/cell-bTemplate:chart/cell^bTemplate:chart/cell-bTemplate: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,tTemplate:chart/cell-tTemplate:chart/cell-tTemplate:chart/cell'tTemplate:chart/cell!tTemplate:chart/cell`tTemplate:chart/cell-tTemplate:chart/cell-tTemplate:chart/cell,bTemplate:chart/cell-bTemplate:chart/cell-bTemplate:chart/cell'bTemplate:chart/cell!bTemplate:chart/cell`bTemplate:chart/cell-bTemplate:chart/cell-bTemplate: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/cellctTemplate:chart/cellcb
{ c
Template:chart/celldtTemplate:chart/celldb
} d
Template:chart/cellttTemplate:chart/celltb
# t
Template:chart/celletTemplate:chart/celleb
[ e
Template:chart/cellftTemplate:chart/cellfb
] f
Template:chart/cellitTemplate:chart/cellib
  i
Template:chart/celljtTemplate: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