Template:ArgDocLine/doc: Difference between revisions

Jump to navigation Jump to search
no edit summary
(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 edit summary
Tag: Reverted
Line 1:
{{Documentationdocumentation}}
This template provides right facing bracket data for [[Template:L]].
 
==Usage==
The [[Template:ArgDocHeader|ArgDocHeader]], [[Template:ArgDocLine|ArgDocLine]], and [[Template:ArgDocFooter|ArgDocFooter]] templates should be used together to build tables of arguments for template documentation.
This template should not normally be linked to, however, it can be, if need be, by entering the following code.
 
<pre>{{L/c}}</pre>
{{ArgDocHeader}}
{{ArgDocLine
|name =
|description =
|optional =
|values =
|default =
}}
{{ArgDocFooter}}
</pre>
 
<includeonly>[[Category:Formatting templates|{{PAGENAME}}]]</includeonly>
==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}}

Navigation menu