|
root |
| ||||||
This is the template sandbox page for Template:Clade (diff). See also the companion subpage for test cases. |
This template is used on approximately 8,500 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Preview message: Transclusion count updated automatically (see documentation). |
This template uses Lua: |
This template uses TemplateStyles: |
This template is used for drawing branching trees with the node and base labels being clickable links. Such diagrams are especially suited to represent evolutionary trees (cladograms).
{{clade
|label1=Base
|1=Node
}}
produces
Base |
Node |
{{clade
|1={{clade
|label1=[[Subtree1]]
|1=Leaf1
|label2=Subtree2
|2=[[Leaf2]]
}}
}}
produces
{{clade
|1={{clade
|label1=Subtree1
|1=Leaf1
|label2=Subtree2
|2=Leaf2
}}
}}
produces
| |||||||
Note that the order of the parameters does not matter. Exactly the same output is produced by
{{clade
|1={{clade
|2=Leaf2
|1=Leaf1
|label1=Subtree1
|label2=Subtree2
}}
}}
| |||||||
The clade template has many features for customising the appearance. Using them optimally requires some understanding of how the template works. The cladogram is constructed using nested HTML tables and the lines of the cladogram are borders of the cells (<td>
tags). Each clade template creates an HTML table with the elements show as follows:
Description | Table cell structure | Cladogram | Code using clade template | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
A simple clade structure with a single child node (or leaf). This is an HTML table with two rows and two columns. The cells of the righthand column are merged using the rowspan attribute. |
|
|
{{clade |thickness=3
|label1=labelA
|sublabel1=sublabelA
|1=LeafA
}}
| ||||||||||||||||||
Replace LeafA with another clade structure. A second HTML table is placed inside a the right-hand cell of the outer table. |
|
|
{{clade |thickness=3
|label1=labelA
|sublabel1=sublabelA
|1={{clade |thickness=3
|label1=label1
|sublabel1=sublabel1
|1=leaf1
|label2=label2
|sublabel2=sublabel2
|2=leaf2
}}
}}
|
The appearance of the cladogram can be customised by changing the border attributes of the HTML cell elements, using the parameters |state=
, |color=
and |thickness=
as shown below:
Description | Template code | Resulting output | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Styling brackets
The thickness, colour and state (solid, dashed, etc.) of bracket lines can be changed using the |
{{clade
|label1=Bracket styling
|sublabel1=(no suffix)
|style1x=background-color:#ffffee;
|1={{Clade
|label2=color
|2={{Clade |color=red
|1=A
|2=B
|3=C
}}
|label1=thickness
|1={{Clade |thickness=3
|1=I
|2=J
|3=K
}}
|label3=state
|3={{Clade |state=dashed
|1=X
|2=Y
|3=Z
}}
}}
}}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||
Styling individual branches
The thickness, colour and state of individual branch lines can be changed using the |
{{clade
|label1=Branch styling
|sublabel1=(append branch number)
|style1x=background-color:#eeeeee;
|1={{Clade
|label2=colorN
|2={{Clade
|1=black (default) |color1=black
|2=red |color2=red
|3=blue |color3=blue
|4= #00ff00 |color4=#00ff00
}}
|label1=thicknessN
|1={{Clade
|1=1 (default) |thickness1=1
|2=2 |thickness2=2
|3=3 |thickness3=3
}}
|label3=stateN
|3={{Clade
|1=solid (default) |state1=solid
|2=dotted |state2=dotted
|3=dashed |state3=dashed
|4=none |state4=none
|5=double |state5=double
}}
}}
}}
|
|
The cladograms can also be generated right to left using {{cladeR}}, as shown below.
Code | Output | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{cladeR |reverse=yes
|label1=''Panthera''
|1={{cladeR
|1={{cladeR
|1=snow leopard
|2=tiger
}}
|2={{cladeR
|1=jaguar
|2={{cladeR
|1=lion
|2=leopard
}}
}}
}}
}}
|
|
While this has limited value in English Wikipedia, it can be useful for presenting alternative phylogenies
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{| style="margin-left: auto; margin-right: auto; border: none;"
|{{clade
|label1=''Panthera''
|1={{clade
|1={{clade
|1=snow leopard
|2=tiger
}}
|2={{clade
|1=jaguar
|2={{clade
|1=lion
|2=leopard
}}
}}
}}
}}
|
{{cladeR
|label1=alternative topology
|1={{cladeR
|1={{cladeR
|1={{cladeR |1= }}
|2={{cladeR |1= }}
}}
|label2=
|2={{cladeR
|1={{cladeR
|1=
|2=
}}
|2={{cladeR |1= }}
}}
}}
}}
|
A common method of presenting phylogenetic data is to use the Newick format. Many published papers provide data in Newick format in their supplementary materials and several taxonomic and phyogenetic websites provide downloads (e.g. Open Tree of Life). These Newick strings can be used to generate cladograms in several ways.
Firstly, the Newick format data can be used to generate the clade structure markup using a text editor or one of several tools.
|
The phylogenetic tree shown to the right is represented by the following Newick and {{Clade}} code
((a,b),(c,d))
{{clade |1={{clade |1=a |2=b}} |2={{clade |1=c |2=d }} }} }}
The manual procedure for conversion in a text editor is
Fortunately, there are a number of methods for automating this task.
use constant N=>"\n";
use constant T=>"\t";
my $tree='((a,b),(c,d));'; # get sequence
$tree=~s/[\n\r]//g; # loose those spaces
$tree=~ s/\:[\.\d]+//g; # loose those lengths
while ($tree=~ m/\(/) {
foreach my $clade ($tree=~ m/\(([^\(\)]+)\)/g) {
my @branches=split /\,/,$clade;
s/(\t+)/$1\t/g for @branches;
die 'ERROR: degenerate/empty node!'.N if $#branches<1;
$tree=~ s/\(\Q$clade\E\)/${\join('','{{clade',N,map(T.'|'.($_+1).'='.$branches[$_].N,0..$#branches),T.'}}')}/; # substitute
}
pos($tree)=0;
}
$tree=~s/(\t*)\t\}\}/$1\}\}/g; # lazy fix
print $tree;
The Newick format data can also be added using the |newickN=
, where N refers to the child node (as with other parameters).
For instance, the following Newick string
((lion,jaguar,leopard),((siberian,bengal)tiger,snow leopard))panthera
can be put in the clade code as in the following example:
Description | Code | Output | Comment | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Simple use of Newick strings |
{{clade
|label1=Label
|1={{clade
|label1=big cats
|1={{clade
|1=clouded leopards
|style2=background-color:#ffdddd
|newick2=((lion,jaguar,leopard),((siberian,bengal)tiger,snow leopard))panthera
|2=Leaf B
}}
}}
}}
|
|
|
The Newick format data provided Open Tree of Life and other sources typically has extraneous encoding data. This can be removed using the |newickN-pattern=
and |newickN-replace=
parameters which supply a Lua pattern (similar to Regex) and replacement. The following code uses Newick format data for the genus Prionailurus downloaded from using Open Tree of Life (source data):
{{clade
|newick1=(Prionailurus_planiceps_ott86166,(((Prionailurus_bengalensis_chinensis_ott198595,Prionailurus_bengalensis_euptilurus_ott547362,Prionailurus_bengalensis_bengalensis_ott5557509,Prionailurus_bengalensis_rabori_ott7067613)Prionailurus_bengalensis_ott280108,Prionailurus_iriomotensis_ott418475),Prionailurus_viverrinus_ott862641),Prionailurus_rubiginosus_ott507541)Prionailurus_ott570215
|newick1-pattern1=([%a_]*)_?(ott[%d]*)
|newick1-replace1=''%1''
|newick1-pattern2=Prionailurus_
|newick1-replace2=P._
|newick1-pattern3=bengalensis_
|newick1-replace3=b._
}}
}}
produces
| |||||||||||||||||||||||||||||||||||||
You can nest the templates and use links around the text. You may use non-breaking spaces ( ) to obtain spaces or to have labels that have spaces.
The entire cladogram can be placed in a box so that text flows nicely around it. You can use {{Cladogram}} to produce the box.
Example |
Example of {{Cladogram}} |
{{cladogram|title=Example
|caption=Example of {{tl|Cladogram}}
|clades={{clade| style=font-size:85%;line-height:85%;
|label1=[[Neornithes]]
|1={{clade
|label1=[[Paleognathae]]
|1=
|label2= [[Neognathae]]
|2={{clade
|1=[[Neoaves]]
|label1=
|label2=[[Galloanserae]]
|2={{clade
|1=[[Anseriformes]]
|label2=
|2=[[Galliformes]]
}}
}}
}}
}}
}}
When one sister is represented as a leaf node and the other as a labelled subclade, they do not appear to be at the same level. Consider this cladogram:
| |||||||||||||
Although Banksia subser. Sphaerocarpae and Banksia subser. Leptophyllae are sisters, their names are not aligned in the cladogram. If this is considered undesirable, one solution is to use a label in both cases, as shown hereafter, which now shows the sisters at the same level.
| |||||||||||||
Another 'trick' is to introduce a dummy clade. The red line in the following example shows where an extra clade has been inserted:
| ||||||||||||||||
To achieve this, instead of
{{clade
|1=Sister1
|label2=Sister2
|2={{clade
|1=taxon1
|2=taxon2}}
}}
which displays as:
Sister1 | |||||||
Sister2 |
| ||||||
use
{{clade
|1=Sister1
|2={{clade <!--extra dummy clade-->
|label1=Sister2
|1={{clade
|1=taxon1
|2=taxon2
}}
}}
}}
which displays as:
Sister1 | ||||||||||
| ||||||||||
To insert a coloured 'bracket' around a set of leaf nodes which follow one another in the generated cladogram:
barbeginN=colour
for the first leaf node, where N is the order of that leaf node within its clade, and colour is the required colour.barN=colour
for the remaining nodes other than the last (note that N must be the order of that node within its clade).barendN=colour
for the last node.Code | Output | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{clade|style=font-size:85%;line-height:100%;
|1={{clade
|1=Leaf A
|2=Leaf B|barbegin2=green
|3=Leaf C|bar3=green
|4={{clade
|1=Leaf D|barend1=green
|2=Leaf E
|3=Leaf F|barbegin3=purple
|4={{clade
|1=Leaf G |bar1=purple
|2=Leaf H |barend2=purple
}}
}}
}}
}}
|
|
Note the using of the non-breaking space (
) to move the vertical bar from the leaf text.
The horizontal lines can be omitted by using |barN=colour
throughout. Thus the following produces simple vertical bars:
Code | Output | Comment | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{clade|style=font-size:85%;line-height:100%;
|1=Leaf A
|2={{clade
|1=Leaf B|bar1=midnightblue
|2=Leaf C|bar2=midnightblue
}}
|3=Leaf D|bar3=midnightblue
}}
|
|
Note that brackets or bars can be applied to internal nodes as well as leaf nodes. So the following code produces the same result. {{clade|style=font-size:85%;line-height:100%;
|1=Leaf A
|bar2=midnightblue
|2={{clade
|1=Leaf B
|2=Leaf C
}}
|3=Leaf D|bar3=midnightblue
}}
|
You can use any of the ways in which colours can be specified in HTML; e.g. the standard colour names, the three or six hex digit notations, such as #FC3 or #F3C630, or the rgb()
notation.
Accessibility guidelines require pages not to rely on colour alone, so it's particularly important to add labels if you have more than one bracket/bar and need to refer to them separately. A couple of methods are available.
|grouplabelN=
parameter. This adds a label to the right of the righthand bracket or bar, as shown in the following example. The right hand column illustrates how |grouplabel=
adds an HTML cell to the right of the terminal leaf.Code | Output | Cell structure | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{clade
|label1=labelA
|grouplabel1=Grouplabel A
|bar1=blue
|1={{clade
|label1=label1
|1= leaf1
|label2=label2
|2= leaf2
}}
}}
|
|
|
In the example above grouplabel was used to label a bar marking the entire clade. It provided an alternative to labelA. However, if the bar is only applied to some terminals, |grouplabelN=
can be used to mark paraphyletic groups. The following example also demonstrates the use of |grouplabelstyleN=
to apply CSS styling to the grouplabel, in this case the color.
Code | Output | ||||
---|---|---|---|---|---|
{{clade
|grouplabel1=ANA Group
|grouplabelstyle1=color:green;
|label1='''Angiosperms'''
|1={{clade
|1=[[Amborellales]] |barbegin1=green
|2={{clade
|1=[[Nymphaeales]] |bar1=green
|2={{clade
|1=[[Austrobaileyales]] |barend1=green
|2=[[Mesangiosperms]]
}}
}}
}}
}}
|
|
The |grouplabel=
parameter can be used to add multiple labels with the aid of the {{clade labels}} template. This template uses absolute CSS positioning to determine the placement of the label. When applied to a |grouplabel1=
parameter on the outer clade it behaves very similarly to {{barlabel}}. A simple example to label two groups is shown below:
Code | Output | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{clade
|label1=root
|1={{clade
|1=Leaf 1 |bar1=green
|2={{clade
|1=Leaf 2 |bar1=green
|bar2=red
|2={{clade
|1=Leaf 3
|2=Leaf 4
}}
}}
}}
|grouplabel1={{clade labels |width=10em;
|label1=stem group |top1=20% |color1=green
|label2=crown group |top2=70% |color2=red
}}
}}
|
|
The |grouplabel=
parameter can contain any Wikitext or allowed HTML content and this offers a lot of flexibility in customising cladograms. The following example uses |grouplabel=
to add an alternative topology using {{cladeR}}:
Code | Output | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{clade
|label1=''Panthera''
|1={{clade
|1={{clade
|1=snow leopard
|2=tiger
}}
|2={{clade
|1=jaguar
|2={{clade
|1=lion
|2=leopard
}}
}}
}}
|grouplabel1=<nowiki/>{{cladeR
|label1=
|1={{cladeR
|1={{cladeR
|1={{cladeR |1= }}
|2={{cladeR |1= }}
}}
|label2=
|2={{cladeR
|1={{cladeR
|1=
|2=
}}
|2={{cladeR |1= }}
}}
}}
}}
}}
}}
|
|
If your cladogram doesn't display brackets/bars as you expected, check that:
barN
, etc. The N must be the same as the number of the child within its clade. Thus typically you should write |N=label for leaf|barN=colour for bar
, e.g. |2=[[Passeridae]]|bar2=midnightblue
.Labels produced by |labelN=
, where N
is 1, 2, ..., can lead to poor layout of the resulting cladogram. (This does not apply to the text of leaves, i.e. text produced by |N=
.) To avoid problems:
Cladograms are drawn by generating hidden tables. The horizontal and vertical lines making up the tree are actually the edges of table cells. The tables are then drawn by the browser or user agent using its internal algorithms. As these differ from browser to browser, the trees produced will not look the same on all browsers.
In particular, as of January 2017[update], there are two algorithms for laying out tables with empty cells, used by two groups of browsers. Most browsers now use the algorithm that produces cladograms like the two on the left in the diagram. Safari (under both MacOS and iOS) uses another algorithm, producing cladograms like the two on the right in the diagram.
No automated "fix" for these differences exists at present.
If there is a choice over the ordering of the terminal nodes (leaves) of the tree, cladograms look best in a Safari-like browser if as much branching as possible is at the bottom of the cladogram. Typically this is produced by arranging the terminal nodes downwards on the page in order of their evolutionary divergence. Compare the bottom row of the diagram to the top row.
There are many known bugs in rendering tables in the software which produces Wikipedia books; see the book tool feedback page. As of July 2011[update] these result in the lines in cladograms not displaying in books. (Cladograms are implemented as HTML tables, which allows complex but hard-to-convert formatting. For an alternative way to include book cladograms, try images.)
There are limitations on the size and complexity of the cladograms which can be drawn:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example exceeding the expansion depth on the twentieth nested clade template. |
Because cladograms are build by nesting {{clade}} templates within each other, larger cladograms can exceed the expansion depth allowed by the Wikimedia software. The cladogram on the right fails on the twentieth nested clade template.
There are two methods to get around this limitation:
This approach uses the template {{clade sequential}} to list taxa in a taxonomic sequence. In the following example six taxa are listed sequentially in the template and the cladogram has the first one as the first branch, the second next and so on until the final two are sisters. Because all taxa are added in one template call, this only counts once towards the 20 limit. The downside is that it is not possible to format each level independently.
Code | Output | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{clade sequential
|1=Leaf 1
|2=Leaf 2
|3=Leaf 3
|4=Leaf 4
|5=Leaf 5
|6=Leaf 6
}}
|
| ||||||||||||||||||||||||||||||||||||||||||
{{clade sequential
|1=Leaf 1
|label2=Clade 2
|2={{clade
|1=Leaf 2A
|2=Leaf 2B
}}
|3=Leaf 3
|label4=Clade 4
|4={{clade
|1=Leaf 4A
|2=Leaf 4B
}}
|5=Leaf 5
|6=Leaf6
}}
|
|
The second example shows that some substructure can be added to each level with normal use of the {{clade}} template.
This method uses the parameters |target=
and |subclade=
to "modularise" the phylogenetic tree. Each subtree is processed in parallel so they don't contribute to the expansion depth in an additive manner. The limit applies to each tree, but many subtrees can be used.
The basic arrangement is illustrated below. The main tree has two subclades, A and B, and subclade B calls a third.
Code | Output | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{Clade
|label1=root |sublabel1=[12/40]
|1={{Clade
|1=Leaf 1
|2={{clade
|1=Leaf 2.1
|2={{clade
|1=Leaf 2.2.1
|2={{clade
|label1=Subclade A
|1={SUBCLADE_A}
|label2=Subclade B
|2={SUBCLADE_B}
}}
}}
}}
}}
|targetA ={SUBCLADE_A}
|subcladeA={{Clade
|1=Leaf A1
|2={{clade
|1=Leaf A2.1
|2={{clade
|1=Leaf A2.2.1
|2=Leaf A2.2.2
}}
}}
}}
|targetB = {SUBCLADE_B}
|subcladeB={{Clade
|1=Leaf B1
|2={{clade
|1=Leaf B.1
|2={{clade
|1=Leaf B2.2.1
|label2=Subclade C
|2={TARGET_C}
}}
}}
}}
|targetC = {TARGET_C}
|subcladeC={{Clade
|1=Leaf C1
|2={{clade
|1=Leaf C2.1
|2={{clade
|1=Leaf C2.2.1
|2=Leaf C2.2.2
}}
}}
}}
|
|
The encoding relies on a number of conventions.
|subcladeA=
, |subcladeB=
, ... |subcladeZ=
contain the subtrees in clade structure that will be substituted into the main tree.|targetA=
, |targetB=
, ... |subcladeZ=
contain the targets where the subtrees will be substituted. For instance, |targetA={SUBCLADE_A
} indicates that the target {SUBCLADE_A}
will be replaced by the content of |subcladeA=content
.{SUBCLADE_A}
and {SUBCLADE_B}
for |subcladeA=
and |subcladeB=
, respectively.|1=
, |label2=
etc.An example of a large phylogenetic tree divided into multiple subtrees can be found at {{Phylogeny/APG IV}}.
Sometimes with large phylogenetic trees it is hard to see the wood for the trees. The cladogram may exceed the screen height making it difficult to see the overall structure and important small clades are too hard to see. A way around this is to collapse the large clades and expand them interactively.
The following example shows a simple example to illustrate the principle:
Code | Output | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{clade |style=font-size:80%;line-height:90%;
|label1='''Amphibia'''
|1={{clade
|1=[[Gymnophiona]] (caecilians)
|label2=[[Batrachia]]
|2={{clade hidden |id=1 |mode=left
|expand-text=(frogs and salamanders)
|1=[[Caudata]] (salamanders)
|2=[[Anura (frog)|Anura]] (frogs)
}}
}}
}}
|
|
A note of caution. The Wikimedia collapsible elements require javascript and are currently disabled in the mobile view. In such cases the whole cladogram will be shown. As with any large phylogentic trees, editors should decide if having a smaller less inclusive tree makes the point more clearly.
Demo |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A cladogram illustrating clade template features. |