Template:Clade/doc/common

==Basic features==

Usage
produces

produces

produces

Note that the order of the parameters does not matter. Exactly the same output is produced by

produces

To replace a solid line leading to the Nth child with a dashed line, use |stateN=dashed.

produces

Tips
An easy way of creating larger cladograms is to use the Newick format and proceed to edit it using a suitable text editor to produce the markup.


 * 1) Start with Newick format ((a,b),(c,d))
 * 2) Replace "(" with ""
 * 3) Edit to replace commas with pipes and numbers
 * 4) Edit clade labels if needed

Alternatively, one can easily generate required clade code by downloading the free Windows utility, 'Claded', via link at http://code.google.com/p/claded, 'Claded' allowing editing of Cladograms using a tree control.

Example Perl script to automate the conversion:

Using a box
You can nest the templates and use links around the text. You may use non-breaking spaces (&amp;nbsp;) 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.

Controlling the layout of sisters
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 below, which now shows the sisters at the same level.

Another 'trick' is to introduce a dummy clade. The dotted line below shows where an extra clade has been inserted:

To achieve this, instead of use {{#ifeq:{{{1|}}}|cladex|

Bracketting nodes
 only. To insert a coloured 'bracket' around a set of leaf nodes which follow one another in the generated cladogram:
 * Add 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.
 * Add barN=colour for the remaining nodes other than the last (note that N must be the order of that node within its clade).
 * Add barendN=colour for the last node.

Either the outermost clade must be specified by or if  is needed there, |style=width:auto must be present.

produces

The horizontal lines can be omitted by using |barN=colour throughout. Thus the following (note the use of |style=width:auto since the outermost clade uses the extra features of ):

produces

Note that brackets or bars must only be applied to leaf nodes. In the example above, it may be tempting to write

with the expectation that the bar will be to the right of the whole of the clade containing Leaf B and Leaf C. This does not produce the required output.

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

Supplying text labels
Text labels for each bracket/bar can be added using Barlabel. 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.

Debugging
If your cladogram doesn't display brackets/bars as you expected, check that: }}
 * You understand the numbering system for the parameters 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</tt>, e.g. |2= Passeridae |bar2=midnightblue</tt>.
 * You have only attempted to apply brackets/bars to leaf nodes.
 * Either the outermost clade uses or if it has to use, then |style=width:auto</tt> is present.

Label length
Labels produced by |labelN=</tt>, where N</tt> 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=</tt>.) To avoid problems:
 * labels should be kept as short as possible, ideally a single word
 * any necessary spaces in labels should be represented as &amp;nbsp; not as actual spaces
 * line breaks (i.e.  ) should not be used.

Browser differences
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, there are two algorithms for laying out tables with empty cells, used by two groups of browsers. Browsers like Internet Explorer and Firefox use one algorithm, producing cladograms like the two on the left in the diagram. Browsers like Safari, Chrome and Opera use 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 the second group of browsers 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.

Large cladograms
There are limitations on the size and complexity of the cladograms which can be drawn:
 * A maximum of 17 children is allowed per node. It may seem that this could easily be increased by editing the template, but see the next point.
 * Cladograms can only be expanded up to a certain level of complexity because the MediaWiki software limits the resources available for template expansion. The cladogram at APG_III_system has had to be broken into three parts, because the entire cladogram exhausts the allowed resources (in this case the allowed expansion depth). Any change to the template could result in large cladograms failing to display correctly. In general, don't exceed a depth of 19, i.e. don't nest one template inside another more than 19 times.

Inclusion in books
There are many known bugs in rendering tables in the software which produces CorporisPublica books; see the [//meta.wikimedia.org/wiki/Book_tool/Feedback book tool feedback page]. these result in the lines in cladograms not displaying in books. This is the common part of the documentation for the two templates Clade and Cladex. Set the first parameter to "clade" or "cladex" to select which version is shown.