Template:Familytree/doc: Difference between revisions

From Tolkien Gateway
No edit summary
 
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<includeonly>{{esoteric}}{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
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.
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
 
This is a template for rendering simple [[family tree]]s consisting of boxes and connecting lines based on an [[ASCII art]]-like syntax.  The trees are displayed as [[HTML]] tables using [[Cascading Style Sheets|CSS]] attributes, and may contain arbitrary [[wiki markup]] within the boxes.


==Example usage==
==Example usage==
Line 9: Line 5:
<pre><nowiki>
<pre><nowiki>
{{familytree/start}}
{{familytree/start}}
{{familytree | | | | Mama |~|y|~| GRP | | Mama=Mama|GRP=Grandpa}}
{{familytree | | | | GRM |~|y|~| GRP | | GRM=[[Grandma]]|GRP=[[Grandpa]]}}
{{familytree | | | | | | | |)|-|-|-|.| }}
{{familytree | | | | | | | |)|-|-|-|.| }}
{{familytree | | | MOM |y| DAD | |DAISY| MOM=Mom|DAD=Dad|DAISY=[[Aunt Daisy]]}}
{{familytree | | | MOM |y| DAD | |DAI| MOM=[[Mom]]|DAD=[[Dad]]|DAI=[[Daisy|Aunt]]}}
{{familytree | |,|-|-|-|+|-|-|-|.| | | }}
{{familytree | |,|-|-|-|+|-|-|-|.| | | }}
{{familytree | JOE | | ME | | SIS | | | JOE=My brother Joe|ME='''Me!'''|SIS=My little sister}}
{{familytree | JOE | | ME | | SIS | | | JOE=[[My elder brother]]|ME='''ME'''|SIS=[[My little sister]]}}
{{familytree/end}}
{{familytree/end}}
</nowiki></pre>
</nowiki></pre>
Line 19: Line 15:


{{familytree/start}}
{{familytree/start}}
{{familytree | | | | Mama |~|y|~| GRP | | Mama=Mama|GRP=Grandpa}}
{{familytree | | | | GRM |~|y|~| GRP | | GRM=Grandma|GRP=Grandpa}}
{{familytree | | | | | | | |)|-|-|-|.| }}
{{familytree | | | | | | | |)|-|-|-|.| }}
{{familytree | | | MOM |y| DAD | |DAISY| MOM=Mom|DAD=Dad|DAISY=[[Aunt Daisy]]}}
{{familytree | | | MOM |y| DAD | |DAISY| MOM=Mom|DAD=Dad|DAISY=Aunt}}
{{familytree | |,|-|-|-|+|-|-|-|.| | | }}
{{familytree | |,|-|-|-|+|-|-|-|.| | | }}
{{familytree | JOE | | ME  | | SIS | | | JOE=My brother Joe|ME='''Me!'''|SIS=My little sister}}
{{familytree | JOE | | ME  | | SIS | | | JOE=My elder brother|ME='''ME'''|SIS=My little sister}}
{{familytree/end}}
{{familytree/end}}


Line 84: Line 80:
<br clear="left" />
<br clear="left" />


*'''Boxes''' can contain arbitrary [[wiki markup]].  The contents of boxes are specified using additional named parameters appended to the template call.  Each box is '''three tiles wide''' and normally has a 2 pixels wide black border.  Boxes can have any name that is a valid template parameter name, although single character names should be avoided to prevent conflicts with tile symbols.
*'''Boxes''' can contain arbitrary wiki markup.  The contents of boxes are specified using additional named parameters appended to the template call.  Each box is '''three tiles wide''' and normally has a 2 pixels wide black border.  Boxes can have any name that is a valid template parameter name, although single character names should be avoided to prevent conflicts with tile symbols.
 
<!--
==Style attributes==
==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 [[Cascading Style Sheets|CSS]] declarations directly to the box style attributes.  For example, the following code:
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:


<pre><nowiki>
<pre><nowiki>
Line 133: Line 129:


'''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 "<code>|RED&nbsp;&nbsp;|</code>" instead of "<code>|&nbsp;RED&nbsp;|</code>" in the example above).  Otherwise the template will end up looking for a style parameter with spaces in its name.
'''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 "<code>|RED&nbsp;&nbsp;|</code>" instead of "<code>|&nbsp;RED&nbsp;|</code>" in the example above).  Otherwise the template will end up looking for a style parameter with spaces in its name.
 
-->
The {{tl|familytree/start}} template also accepts an optional ''style'' parameter that can be used to set CSS styles for the entire table.
 


<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Genealogy templates|{{PAGENAME}}]]
[[Category:Family tree templates|{{PAGENAME}}]]


</includeonly>
</includeonly>
<noinclude>[[Category:Family tree templates|{{PAGENAME}}]]</noinclude>

Latest revision as of 14:16, 8 April 2021

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[edit source]

This code: 

{{familytree/start}}
{{familytree | | | | GRM |~|y|~| GRP | | GRM=[[Grandma]]|GRP=[[Grandpa]]}}
{{familytree | | | | | | | |)|-|-|-|.| }}
{{familytree | | | MOM |y| DAD | |DAI| MOM=[[Mom]]|DAD=[[Dad]]|DAI=[[Daisy|Aunt]]}}
{{familytree | |,|-|-|-|+|-|-|-|.| | | }}
{{familytree | JOE | | ME | | SIS | | | JOE=[[My elder brother]]|ME='''ME'''|SIS=[[My little sister]]}}
{{familytree/end}}

Produces this:

 
 
 
Grandma
 
 
 
Grandpa
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Mom
 
Dad
 
Aunt
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
My elder brother
 
ME
 
My little sister
 
 


Parameters[edit source]

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
 
 
 
   h
 
 
 
  
]
 
 
 
   [
 
 
 
  


  • Boxes can contain arbitrary wiki markup. The contents of boxes are specified using additional named parameters appended to the template call. Each box is three tiles wide and normally has a 2 pixels wide black border. Boxes can have any name that is a valid template parameter name, although single character names should be avoided to prevent conflicts with tile symbols.
Retrieved from "https://tolkiengateway.net/w/index.php?title=Template:Familytree/doc&oldid=330174"