Template:Category scope/doc

This is a template that provides a hatnote at the top of a category, explaining the extent of its scope.

Usage
optional.

Parameters

 * topic – Wording about the topical nature of the material; this wording follows "This category covers" and precedes . Example value: species found in.   (or consistently for a set of related categories, e.g. on regional flora and fauna), when used at all.

{{#if:{{{version|}}}

Documentation of derived templates
Documentation of templates derived from this meta-template can be done in-situ the usual way, or with a transclusion after the template code. The latter option customizes the documentation based on the following parameters (the first mandatory): }}
 * version – : the name of the category topic (and usually the main article on the subject, e.g.: South America. Presence of this parameter suppresses documentation relating the meta-template itself (e.g. the entire section you are reading now), and customizes the output to match the specific template in question.
 * namely – Wording about the categorical nature of the scope, a concise descriptor of the inline list provided in scope of the template itself. This will cause the documentation to display "...explaining the extent of its scope, namely" then the value of namely and a period/stop (instead of just "...explaining the extent of its scope."). See Template:Category scope South America for an example.
 * note – A sentence (or more) with any template-specific notes, e.g. about the intent of the default scope provided by the template. The output is formatted as a (thus, can contain multiple paragraphs) after the first sentence of the documentation, before the "Usage" secton. See Template:Category scope South America for an example.
 * custom-parameters – Any custom parameters supported by the specific template may be passed into the above main template documentation with this parameter of the doc transclusion, and will appear below the template parameter documentation for topic, above. Each parameter line-item must begin on a newline and start with the  character, so that it is formatted as part of the above template parameter documentation list. See Template:Category scope South America for an example.