The official discord link if you wish to join the discord: https://discord.gg/j5RKwCvAFu

Support the wiki on our official Ko-Fi page or Patreon page!

Template:FamilyTree/doc

From The Codex
Revision as of 04:31, 4 November 2024 by GiverOfThePeace (talk | contribs) (Created page with "This is a template for rendering simple family trees consisting of boxes and connecting lines based 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. ==Example usage== This code: <pre><nowiki> {{FamilyTree/Start}} {{FamilyTree | | | | GRM |~|y|~| GRP | | GRM=Grandma|GRP=Grandpa}} {{FamilyTree | | | | | | | |)|-|-|-|.| }} {{Fa...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This is a template for rendering simple family trees consisting of boxes and connecting lines based 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.

Example usage

This code:

{{FamilyTree/Start}}
{{FamilyTree | | | | GRM |~|y|~| GRP | | GRM=Grandma|GRP=Grandpa}}
{{FamilyTree | | | | | | | |)|-|-|-|.| }}
{{FamilyTree | | | MOM |y| DAD | |AUNT| MOM=Mom|DAD=Dad|AUNT=Aunt}}
{{FamilyTree | |,|-|-|-|+|-|-|-|.| | | }}
{{FamilyTree | JOE | | ME  | | SIS | | | JOE=My brother Joe|ME='''Me!'''|SIS=My little sister}}
{{FamilyTree/End}}

Produces this:

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

Parameters

This template produces one row in a family tree table. The template accepts up to 99 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 single-character symbols that 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 supported tiles is given below.
Solid lines:
,
 
 
 
 
  .
 
 
 
  `
 
 
 
  '
 
 
 
 
^
 
 
 
  v
 
 
 
  (
 
 
 
  )
 
 
 
 
-
 
 
  !
 
 
  +
 
 
 
 
 
 
 
Dashed lines:
F
 
 
 
 
  7
 
 
 
  L
 
 
 
  J
 
 
 
 
A
 
 
 
  V
 
 
 
  C
 
 
 
  D
 
 
 
 
~
 
 
  :
 
 
  %
 
 
 
 
 
Mixed:
*
 
 
 
 
  #
 
 
 
 
  y
 
 
 
  U
 
 
 
 


Style attributes

The appearance of the boxes may be controlled by the optional template parameters border and boxstyle. The former sets the width of the box border in pixels, while the latter can be used to append arbitrary CSS declarations directly to the box style attributes. For example, the following code:

{{FamilyTree/Start |summary=Box 1 married to Box 2, with children Box 3 and Box 4}}
{{FamilyTree|border=0|boxstyle=background:#dfd;| | FOO |y| BAR | |FOO=Box 1|BAR=Box 2}}
{{FamilyTree|border=0|boxstyle=background:#dfd;| | |,|-|^|-|.| | }}
{{FamilyTree|border=0|boxstyle=background:#dfd;| | FOO | | BAR | |FOO=Box 3|BAR=Box 4}}
{{FamilyTree/End}}
</nowiki>

produces a result like this:

 
Box 1
 
Box 2
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Box 3
 
Box 4
 

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

{{FamilyTree/Start |White box with three children Red box, Green box, Blue box, all married to each other}}
{{FamilyTree| | | | |WHITE| | | | |WHITE=White box}}
{{FamilyTree| |,|-|-|'|!|`|-|-|.| }}
{{FamilyTree|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;
}}
{{FamilyTree/End}}

which produces the output:

 
 
 
 
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 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.

See also