Bureaucrats, editor, Interface administrators, Administrators (Semantic MediaWiki), Curators (Semantic MediaWiki), Editors (Semantic MediaWiki), Administrators
47,327
edits
Template:ArgDocLine/doc: Difference between revisions
no edit summary
No edit summary Tag: Reverted |
No edit summary Tag: Manual revert |
||
Line 1:
{{
The [[Template:ArgDocHeader|ArgDocHeader]], [[Template:ArgDocLine|ArgDocLine]], and [[Template:ArgDocFooter|ArgDocFooter]] templates should be used together to build tables of arguments for template documentation.
<
{{ArgDocHeader}}
{{ArgDocLine
|name =
|description =
|optional =
|values =
|default =
}}
{{ArgDocFooter}}
</pre>
==Arguments==
{{ArgDocHeader|caption=ArgDocHeader}}
{{ArgDocLine
|name = caption
|description = Caption for the table
|optional = Yes
|values = Any text
}}
{{ArgDocFooter}}{{ArgDocHeader|caption=ArgDocLine}}
{{ArgDocLine
|name = name
|description = Name of the argument. Do not set this if the argument is anonymous (unnamed).
|optional = Yes
|values = Any text
}}
{{ArgDocLine
|name = description
|description = Description of the argument
|optional = Yes
|values = Any text
}}
{{ArgDocLine
|name = optional
|description = Is the argument optional?
|optional = Yes
|values = <code>Yes</code> <code>No</code>
|default = <code>No</code>
}}
{{ArgDocLine
|name = values
|description = Values the argument accepts
|values = Any text
}}
{{ArgDocLine
|name = default
|description = The default value for the argument, if any
|optional = Yes
|values = Any text
}}
{{ArgDocFooter}}
| |||