Module:Autotaxobox/doc

Module:Autotaxobox

The purpose of this module is to provide support for automated taxobox templates (such as Automatic taxobox or Speciesbox), avoiding Mediawiki template expansion depth errors in the traversal of the taxonomic hierarchies encoded in taxonomy templates.

Currently processing is arbitrarily limited to hierarchies containing at most levels.

taxoboxColour
Given a taxon name, this function returns the correct colour of an automated taxobox for that taxon. It does so by searching up the taxonomic hierarchy for a 'real' taxon (i.e. not incertae sedis) that sets the taxobox colour, and then returning that colour. If no 'real' taxon is found, then if an incertae sedis taxon was found, the incertae sedis colour is returned, otherwise "transparent" is returned. (If the taxonomic hierarchy is too deep to process, the error colour is returned.)

Usage:



Parameters:


 * The unnamed parameter should be the name of a taxon for which "Template:Taxonomy/taxon_name" exists.

Examples:



taxoboxList
Given a taxon name, this function returns the rows of taxa in an automated taxobox, based on the taxonomic hierarchy for the supplied taxon.

Usage:

Parameters:


 * The unnamed parameter should be the name of a taxon for which "Template:Taxonomy/taxon_name" exists. The others are explained above.

Examples:

taxonomyList
Given a taxon name, this function returns the rows of the taxonomy table displayed on the "Template:Taxonomy/taxon_name" page, based on the taxonomic hierarchy for the supplied taxon name.

When descending the taxonomic hierarchy, if a rank is found that is either at the same level or higher than a rank already encountered (e.g. a family is found below a subfamily), the cell displaying the rank is given a reddish background. The numerical values defined in  are used to determine the correct sequence of ranks.

Usage:



Parameters:


 * The unnamed parameter should be the name of a taxon for which "Template:Taxonomy/taxon_name" exists.

Examples:

callTaxonomyKey
This function prepares for, and then calls, Taxonomy key to display a taxonomy template page. It does this by building up the information the template requires, following one  link if present, and then calling it.

Usage:

taxonInfo
Given the names of a taxon and the required item of information stored in the taxon's taxonomy template, this function returns the value of the item, following one "same as" link if available and the value would otherwise be the empty string. The function would normally be used externally via Taxon info.

Usage:



Parameters:


 * The first unnamed parameter should be the name of a taxon for which "Template:Taxonomy/taxon_name" exists.
 * The possible values of the second unnamed parameter are given at Taxon info/doc.

Examples:



taxonLink
Returns a wikilink to a taxon, if required including '†' before it and ' (?)' after it, and optionally italicized or bolded without a wikilink. It would normally be used via Taxon link. Some parameters can, under some circumstances, be omitted.

Usage:

(having '/?' at the end triggers the output of ' (?)') ('yes' or 'true' trigger the output of '†') ('yes' makes the core output bold and not wikilinked) ('yes' makes the core output italic) (without †, italics, etc.)

Examples:



showRankTable
Returns a sortable wikitable containing the ranks and corresponding numerical values defined in  and used in checking the consistency of a taxonomic hierarchy. A taxon should always have a lower numerical value than one higher in the taxonomic hierarchy.

Usage:



Utilities
These functions are intended to be used only in analysing taxonomic hierarchies, e.g. in testing and debugging, and not for direct use in templates used in the automated taxobox system.

nth
Given a taxon name, this function returns the nth taxon above it in the taxonomic hierarchy.

Usage:



Parameters:


 * The unnamed parameter should be the name of a taxon for which "Template:Taxonomy/taxon_name" exists.
 * n is the level whose taxon is to be found

Examples:



nLevels
Given a taxon name, this function returns the number of levels at and above it in the taxonomic hierarchy.

Usage:



Parameters:


 * The unnamed parameter should be the name of a taxon for which "Template:Taxonomy/taxon_name" exists.

Examples:



listAll
Given a taxon name, this function returns a comma-separated list of all the levels at and above it in the taxonomic hierarchy.

Usage:



Parameters:


 * The unnamed parameter should be the name of a taxon for which "Template:Taxonomy/taxon_name" exists.

Examples: