Template:Informative template: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Adding __NOTOC__ to the copyable example as I nearly always have to add that)
m (Moving the category outside the template in the copy-pastable example to reflect the common usage)
Line 27: Line 27:
== Related templates ==
== Related templates ==
* {{tl|example}}
* {{tl|example}}
}}


[[Category:Templates]]
[[Category:Templates]]
}}
<nowiki>&lt;/noinclude&gt;</nowiki>
<nowiki>&lt;/noinclude&gt;</nowiki>
</pre>
</pre>

Revision as of 10:12, 7 November 2013

The following template description is not displayed when the template is inserted in an article.

{{{1}}}


The following template description is not displayed when the template is inserted in an article.

Goal

This template can be used to documentate a wiki template and to distinguish the documentation from the actual template.

Usage

The template is used with one variable en must be put between <noinclude></noinclude> tags. Please put the <noinclude> tag right behind the intended contents of the template, as an empty line or extra spaces will alter the way the template is rendered.

<noinclude>
{{Informative template|1=
__NOTOC__
== Goal ==
The intended use of the template.

== Usage ==
An overview of the available template options.

== Examples ==
Examples using different options.

== Related templates ==
* {{tl|example}}

}}

[[Category:Templates]]
</noinclude>

Please use at least the following sections:

  • Goal
  • Usage

And, when applicable:

  • Examples
  • Default values
  • Related templates