Template:Taxonavigation/doc

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Taxonavigation.

---

Usage

This template helps the reader to navigate to upper categories corresponding to upper rank taxa. (To help navigation to lower ranks, use {{Taxa}}, {{Genera}}, {{Species}} and {{Subspecies}})
This template should be used on taxon categories and taxon galleries BUT never in files.

Note: if you want to edit this template, first try your modifications on {{Taxonavigation/sandbox}}.You can then test your edits in {{Taxonavigation/testcases}}.
When the new version is ready, ask an administrator to move it to the main template. You can do that by putting a {{Edit request}} in the template talk page and explaining that the admin just needs to copy the sandbox code into the main template.

Sample

{{Taxonavigation|
classification=APGIII|                     <-- classification= should be at the beginning
include=angiosperms|                       <-- include= should be at the second position
Cladus|magnoliids|
Ordo|Laurales|
Familia|Lauraceae|
Genus|Cinnamomum|
Species|Cinnamomum camphora|               <-- here you must put the whole species name, for the link to the potential category
authority=(L.) J. Presl}}                  <-- authority= should be at the end

will result in

APG III Classification: Domain: Eukaryota • (unranked): Archaeplastida • Regnum: Plantae • Cladus: Angiosperms • Cladus: magnoliids • Ordo: Laurales • Familia: Lauraceae • Genus: Cinnamomum • Species: Cinnamomum camphora (L.) J. Presl

Ranks

Singular latin ranks should be used: Cladus, Domain, Regnum, Phylum, Divisio, Classis, Cohors, Ordo, Familia, Tribus, Genus, Sectio, Series, Species, Hybrid, Cultivar, Varietas

For intermediate ranks, use the syntax without separator like subgenus and infraordo (not "sub-genus", nor "infra ordo")

If you use incorrect ranks, the article/category will be shown in Category:Pages with incorrect biology template usage.

Limitations

Up to 19 different ranks can be used.

Content rules

• Rule 1: Red links:
  There should be no red links unless it's very likely the category will be created in the near future. This is because taxonavigation is not a taxobox, but a help to navigate between existing hierarchical categories.
• Rule 2: Synonyms:
  The taxonavigation should contain the name of the current category/article. So if you think that the current category/article is an invalid name (a synonym):
  • Either you rename the category/article + change the taxonavigation
  • Either keep the category/article name in Taxonavigation + provide the {{SN}} with a comment like {{SN|''valid name'' (preferred by {{Taxasource|Kew list}}) }}

Parameter authority=

If you provide the authority= parameter: parentheses, when present, have a special meaning and must be preserved.

Parameter include=

To avoid having too many taxa in the Taxonavigation parameters, an include= functionality has been added.
You can only include a subtemplate from Category:Templates to include in Taxonavigation.
These templates have been created using {{TaxonavigationIncluded}} and mostly represent classes.
Please don't create one of those include templates without having read their policy.

Parameter classification=

Classification is always changing, for that reason there are many different classifications (see [1] for the different classifications of the same family).
So we should always provide the name of the classification with the parameter classification= (for example |classification=Cronquist)
Multiple classifications can be provided on the same page with multiple call to {{Taxonavigation}}.
If there is a conflict between Category:Angiosperms classifications, prefer APG III
Available value for classification:

• for Angiosperms:
  • Cronquist for Cronquist System
  • Strasburger for Strasburger
  • APG II for APG II Classification
  • APG III for APG III Classification
  • APWebsite for APWebsite (the website where the future APG III is in preparation)
• for Ferns
  • Smith for Smith System
• for Birds:
  • IOC for IOC Classification
  • HBW for Handbook of the Birds of the World
• for Gastropoda:
  • Bouchet&Rocroi2005 for Bouchet & Rocroi (2005)
  • Jörger et al. (2010) for Jörger et al. (2010)
• for Bivalvia:
  • Bouchet et al. (2010) for Bouchet et al. (2010)
• to add others, just modify {{Taxonavigation/classification}}

See also

• {{TaxonavigationIncluded}} a copy of this template, used by templates referenced by include=
• {{TaxonavigationIncluded2}} a copy of this template, used by templates referenced by include=
• sub-templates
  • Module:Taxonavigation the underlying lua module
  • {{Taxonavigation/classification}} used when classification= is provided
  • {{Incorrect biology template usage}}

Technical documentation (for template)

• What templates are called in which order:
  • Category:Agave calls:
    • {{Taxonavigation}} (Propagates documentTemplate, categorizeTemplate, classification, namespaceForDebug, pagenameForDebug to include + calculate and pass rank to include)
      • Module:Taxonavigation:serializeCurrentParameters (calculates parameters)
      • Module:Taxonavigation:findCurrentPageTaxonRank (temporare) (calculates rank)
      • {{Archaeognatha}} (Propagates rank & parameters to TaxonavigationIncluded2. Calls TaxonavigationIncluded2 with categorizeGeneraIn2=FAMILIA)
        • {{TaxonavigationIncluded2}} (Propagates rank (or calculates it) to include)
          • {{Angiosperms}} (Propagates rank, parameters, namespaceForDebug, pagenameForDebug, documentTemplate, categorizeTemplate to TaxonavigationIncluded}
            • {{TaxonavigationIncluded}}
              • Module:Taxonavigation:taxonavigation
          • Module:Taxonavigation:taxonavigation manages categorizeGeneraIn2=FAMILIA and parameters
      • Module:Taxonavigation:taxonavigation