Editing Module:Autotaxobox/doc (section)

==Utilities==
These functions are intended to be used only in analysing and understanding the automated taxobox system, including the taxonomic hierarchies encoded in taxonomy templates – for example in testing and debugging. They are not part of the functioning of the automated taxobox system.

===getMaxSearchLevels===
Returns the maximum number of levels of a taxonomic hierarchy encoded in taxonomy templates that the system will search.

Usage:
:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|getMaxSearchLevels}}</code> → {{#invoke:Autotaxobox|getMaxSearchLevels}}

===showRankTable===
Returns a sortable wikitable containing the ranks and corresponding numerical values defined in <code>getRankTable()</code> and used in checking the consistency of a taxonomic hierarchy. If a taxon has a value in the rank table, it should always be lower than one higher in the taxonomic hierarchy.

Usage:

:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|showRankTable}}</code>

===find===
Given a taxon name and a rank, this function returns the taxon's ancestor of the given rank.

Usage:
:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|find|''taxon_name''|''rank''}}</code>

Parameters:
:The first unnamed parameter should be the name of a taxon for which "Template:Taxonomy/''taxon_name''" exists.
:The second unnamed parameter should be the Latinized name of a rank.

Examples:
:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|find|Felis|ordo}}</code>  → {{#invoke:Autotaxobox|find|Felis|ordo}}
:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|find|Felis|classis}}</code>  → {{#invoke:Autotaxobox|find|Felis|classis}}
:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|find|Pteranodon|phylum}}</code> → {{#invoke:Autotaxobox|find|Pteranodon|phylum}}
:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|find|Pteranodon|classis}}</code> → {{#invoke:Autotaxobox|find|Pteranodon|classis}}

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

Usage:

:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|nth|''taxon_name''|n=''integer''}}</code>

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:

:<nowiki>{{#invoke:Autotaxobox|nth|Felis|n=1}}</nowiki> → {{#invoke:Autotaxobox|nth|Felis|n=1}}
:<nowiki>{{#invoke:Autotaxobox|nth|Felis|n=15}}</nowiki> → {{#invoke:Autotaxobox|nth|Felis|n=15}}

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

Usage:

:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|nLevels|''taxon_name''}}</code>

Parameters:

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

Examples:

:<nowiki>{{#invoke:Autotaxobox|nLevels|Felis}}</nowiki> → {{#invoke:Autotaxobox|nLevels|Felis}}
:<nowiki>{{#invoke:Autotaxobox|nLevels|Pteranodon}}</nowiki> → {{#invoke:Autotaxobox|nLevels|Pteranodon}}

===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:

:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|listAll|''taxon_name''}}</code>

Parameters:

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

Examples:

:<nowiki>{{#invoke:Autotaxobox|listAll|Plantae}}</nowiki> → {{#invoke:Autotaxobox|listAll|Plantae}}
:<nowiki>{{#invoke:Autotaxobox|listAll|Felis}}</nowiki> → {{#invoke:Autotaxobox|listAll|Felis}}

===removeQualifier===
Given a taxon name, this function returns the name with any qualifier (i.e. any part after a "/") removed.

Usage:

:<code><nowiki>{{</nowiki>#invoke:Autotaxobox|removeQualifier|''taxon_name''}}</code>

Examples:

:<nowiki>{{#invoke:Autotaxobox|removeQualifier|Eukaryota/display}}</nowiki> → {{#invoke:Autotaxobox|removeQualifier|Eukaryota/display}}
:<nowiki>{{#invoke:Autotaxobox|removeQualifier|Felis}}</nowiki> → {{#invoke:Autotaxobox|removeQualifier|Felis}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Taxobox templates]]

}}</includeonly>