Template:Documentation
From Pizza Tower Wiki
Template documentation
|
|---|
| Note: portions of the template sample may not be visible without values provided. |
| View or edit this documentation. (About template documentation) |
| Editors can experiment in this template's sandbox and test case pages. |
- Description
- This template is used to insert documentation on how to use it on it's Template page.
- Syntax
- Add
{{Documentation}}inside of<noinclude>tags at the end of a template page. Alternatively,{{Documentation|(documentation page)}}will transclude an alternate page from the /doc subpage.
Examples
- Template page
- Typically, it's implementation on the page will look like this in code:
<includeonly>
(TEMPLATE CODE)
</includeonly><noinclude>{{Documentation}}[[Category:Templates]]</noinclude>
- Documentation page
The documentation page will be located under the /doc subpage unless specified otherwise. Format the documentation as such:
; Description
: This template is used for a purpose.
; Syntax
: Copy this boilerplate code to the page and fill up its parameters:
<pre> {{Template name
|value-1 =
|value-2 =
|value-3 =
}}</pre>
* <code>value-1</code> does something.
* <code>value-2</code> does something else. Optional.
* <code>value-3</code> does one more thing.
== Examples ==
: [[Page that uses template]], code:
<pre>
{{Template name
|value-1 = hello
|value-2 = world
|value-3 = !
}}</pre>
: Result:
{{Template name
|value-1 = hello
|value-2 = world
|value-3 = !
}}
