This template includes the "top" of the table for any template documents. Calls to this table should be followed by rows which document each of the templates parameters and finally the table should be "closed" by inserting |} after the final row.
Template Parameter Documentation Table
| Parameter
|
Description
|
Examples
|
title
|
the text to put into the document table caption
|
this page, for example: |title=Template Parameter Documentation Table
|
A full example:
{{docs|title=demonstration template}}
<!-- test parameter -->
|-
| <code>test</code>
| a testing parameter
| <code>|test=testing things</code>
|-
<!-- image parameter -->
{{docs/image|eg=File: Test Image.svg}}
|}
|
Template:Docs/image
demonstration template
| Parameter
|
Description
|
Examples
|
test
|
a testing parameter
|
|test=testing things
|
|
Common Parameter Rows
Row Formatting
Templates with Documentation
For a full listing, see
here.
