View source for Template:Clade labels/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

This is a utility template for labelling cladograms made with the {{tl|clade}} template. In particular it is for use with {{para|grouplabelN}} and adding multiple labels with defined positions.

The functionality of this template is similar to {{tl|barlabel}}.

===Parameters===

The following parameters apply to each label:

* {{para|labelN}} (where N is 1,2, ... N) &ndash; the text to place in the label
* {{para|topN}} &ndash; the position of the label from the top of the table cell containing the group label. It is recommended that the value be given in %, e.g. 50% to center the label. This is the CSS property so the values can also be given in other units.
* {{para|bottomN}}, {{para|leftN}}, {{para|leafN}} &ndash; similar to {{para|topN}} these parameters position the  bottom, left and right of the label. The behaviour is counter-intuitive. Because {{para|leftN}} shifts the left edge of the label, the result is a shift to the right.
* {{para|styleN}}&ndash; add CSS styleing specific to the numbered label. 
* {{para|colorN}} &ndash; changes the color of text in the label. 

The following parameters apply to all the labels in the group:

* {{para|width}} &ndash; fixes the width of the element containing the group of labels. This is useful because the positioning uses absolute CSS positions so they don't automatically change the size of the parenet element. As a result the labels can appear outside the parent element.
* {{para|style}} &ndash; applies a common CCS style to all the labels 
* {{para|left}} &ndash; shifts all the labels to the right. 
* {{para|top}},{{para|bottom}}, {{para|right}} &ndash; similar to {{para|left}} these shift the positions of all the labels
* {{para|color}} &ndash; changes the color of text in all the labels. 

===Example===
{{clade example|code=|output=
|code1=<pre>{{clade
|label1=root
|1={{clade
   |1=Leaf 1 |bar1=green
   |2={{clade
      |1=Leaf 2&nbsp; |bar1=green
      |bar2=red
      |2={{clade
         |1=Leaf 3&nbsp; 
         |2=Leaf 4 
         }}
      }}
   }}
|grouplabel1={{clade labels |width=10em;
             |label1=stem group  |top1=20% |color1=green
             |label2=crown group |top2=70% |color2=red
             }}  
}}
</pre>
|output1={{clade
|label1=root
|1={{clade
   |1=Leaf 1 |bar1=green
   |2={{clade
      |1=Leaf 2&nbsp; |bar1=green
      |bar2=red
      |2={{clade
         |1=Leaf 3&nbsp; 
         |2=Leaf 4 
         }}
      }}
   }}
|grouplabel1={{clade labels |width=10em;
             |label1=stem group  |top1=20% |color1=green
             |label2=crown group |top2=70% |color2=red
             }}  
}}
}}

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly>