Template:ArgDocLine/doc: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
(Created page with "{{Documentation}} The ArgDocHeader, ArgDocLine, and ArgDocFooter templates should be used together to build tables of arguments for template documentation. <pre> {{ArgDocHeader}} {{ArgDocLine |name = |description = |optional = |values = |default = }} {{ArgDocFooter}} </pre> ==Arguments== {{ArgDocHeader|caption=ArgDocHeader}} {{ArgDocLine |name = caption |description = Caption for the tab...") |
(No difference)
|
Revision as of 01:48, 12 October 2024
The ArgDocHeader, ArgDocLine, and ArgDocFooter templates should be used together to build tables of arguments for template documentation.
{{ArgDocHeader}} {{ArgDocLine |name = |description = |optional = |values = |default = }} {{ArgDocFooter}}
Arguments
Argument | Optional? | ||||
---|---|---|---|---|---|
caption | Caption for the table | ||||
Values | Any text | ||||
Argument | Optional? | ||||
---|---|---|---|---|---|
name | Name of the argument. Do not set this if the argument is anonymous (unnamed). | ||||
Values | Any text | ||||
description | Description of the argument | ||||
Values | Any text | ||||
optional | Is the argument optional? | ||||
Values | Yes No
|
Default | No
| ||
values | Values the argument accepts | ||||
Values | Any text | ||||
default | The default value for the argument, if any | ||||
Values | Any text | ||||