Module:Clade/hidden/doc

Clade System
Templates and modules for generating cladograms
Modules
Module:Clade Module:Clade/hidden Module:Clade/gallery Module:Clade/example Module:Clade/transclude
Related templates
{{Clade}} {{CladeR}} {{Clade hidden}} {{Clade gallery}} {{Clade example}} {{Clade box}} {{Clade transclude}}
Help
Basics	Using clade Customise brackets Table structure
Tips	Newick Annotations Alignment
Technical help
mw:Extension:Scribunto/Lua_reference_manual mw:Manual:Collapsible_elements

This module contains the code for {{Clade hidden}}

Useful help page:

Usage

{{#invoke:Clade/hidden|hidden}}

Documentation transcluded from the template

The pages listed in this category are templates.

This page is part of OODA WIKI's administration and not part of the encyclopedia.

Further template category notes

This category contains pages in the template namespace. It should not be used to categorize articles or pages in other namespaces.

To add a template to this category:

• If the template has a separate documentation page (usually called "Template:template name/doc"), add
•  [[Module:Clade/hidden/doc]]
• to the <includeonly> section at the bottom of that page. Otherwise, add
•  <noinclude>[[Module:Clade/hidden/doc]]</noinclude>
• to the end of the template code, making sure it starts on the same line as the code's last character.

This category is an index of templates which use TemplateStyles. It is automatically populated by {{Uses TemplateStyles}}.

Creates an interactive clade element that is collapsible. The initial state can be collapsed (hidden) or expanded (visible). Interactivity is achieved by clicking appropriate symbols in the cladogram (e.g. ⊞ or ⊟) or custom interactive elements can be added externally with {{clade toggle}}.

This feature is intended to be used sparsely on large clagograms where the whole structure cannot be seen in the screen window.

Parameters

Parameters as {{clade}} with the addition of the following:

• |expanded=true – sets initial state to expanded (default: hidden)
• |id= – id to control interactivity; use unique ids for independent behaviour or same ids for shared behaviour
• |expand-symbol= – symbol for expansion (e.g. &#8862; --> ⊞ or &#10753; --> ⨁)
• |collapse-symbol= – symbol for collapsing (e.g. &#8863; --> ⊟ or &#10754; -->⨂)
• |mode=left – position of collapse symbol (left or right of the clade content; default: left)
• |expand-text=(expand text) – text to replace hidden content
• |collapse-text=(collapse text) – text to show with collapse symbol (when |mode=right)

Development note: The behaviour of the hidden element when in mobile mode or with javascript disable is controlled in {{clade hidden/styles.css}}. The currentl behaviour is to hide the symbols and leave the expanded content. The following CSS code can hide the content in these modes. However there are currently a couple of issues: width of labels on collapsed elements if on dummy clade; initial state of content when |expanded=true.

table.clade td.clade-interactive  div.mw-collapsible-content { display:none; }

Examples

Code	Output
{{Clade |label1=root |1={{Clade |1=Unhidden Leaf |label2=Hidden clade |2={{Clade hidden |id=1 |1=Leaf1 |2=Leaf2 }} }} }}	root Unhidden Leaf Hidden clade ⊞ Leaf1 Leaf2 ⊟
{{Clade |label1=root |1={{Clade |1=Unhidden Leaf |label2=Collapsible clade |2={{Clade hidden |id=2 <!-- clade hidden parameters --> |expanded=true |mode=right |expand-text=(expand text) |collapse-text=(collapse text) |expand-symbol=&#10753; |collapse-symbol=&#10754; |1=Leaf1 <!-- standard clade parameters --> |2=Leaf2 }} }} }}	root Unhidden Leaf Collapsible clade ⨁(expand text) Leaf1 Leaf2 ⨂(collapse text)