Template:Tp/doc

From Gentoo Wiki
Jump to: navigation, search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.

As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

This template can be used in template documentation to refer to a template parameter name or value. The context should make it clear which is being referred to. (It can also be used to show the assignment of a value to a named parameter, as illustrated below.)

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 Yes (n/a) template parameter name, value, or assignment.

Usage

{{tp|parameter}}

See the template's testcases:

Correct

Marking up a template parameter (named parameter, or value of an anonymous parameter)
Wiki code
{{Tp|link}}
Main version
link
Sandbox version


Showing a parameter being assigned a value
Wiki code
{{Tp|link{{=}}y}}
Main version
link=y
Sandbox version


Another way to show a parameter being assigned a value
Wiki code
{{Tp|1=link=y}}
Main version
link=y
Sandbox version


Incorrect

No parameter (lack of input results in an empty <code> element)
Wiki code
{{Tp}}
Main version
Sandbox version