Habbo Wiki
(Created page with '{{documentation}} The '''documentation''' template is transclude the template documentation. This template should only be used on a subpage titled "doc". ==Usage== Place <code>…')
 
(Updating.)
Tag: sourceedit
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{documentation}}
+
<noinclude>{{documentation subpage}}</noinclude>__NOWYSIWYG____NOEDITSECTION__
  +
<!-- Categories for transclusion to template go at bottom of this doc. -->
The '''documentation''' template is transclude the template documentation. This template should only be used on a subpage titled "doc".
 
  +
{{TOCright}}
  +
=== Description ===
   
  +
'''{{FULLPAGENAME}}''' is used to insert descriptions on [[Help:template|template]] pages.
==Usage==
 
  +
Place <code>{{t|documentation}}</code> at the top of the documentation page.
 
  +
=== Syntax ===
<includeonly>[[Category:Template documentation| ]]</includeonly>
 
  +
  +
{{tag|noinclude|open}}{{tlx|documentation}}{{tag|noinclude|close}}
  +
  +
at the end of the template page.
  +
  +
=== General usage ===
  +
==== On the Template page ====
  +
<pre>
  +
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
  +
{{documentation}}</noinclude>
  +
</pre>
  +
  +
{{note}} Depending on the template, you may need to insert the {{tlx|clr}} template (or complete a table/div) just before inserting {{tag|noinclude|open}}{{tlx|documentation}}{{tag|noinclude|close}}.
  +
  +
The line break is also useful as it helps prevent the documentation template "running into" previous code.
  +
  +
==== On the Template/doc page ====
  +
<pre>
  +
<noinclude>{{documentation subpage}}</noinclude>
  +
=== Description ===
  +
  +
'''{{FULLPAGENAME}}''' is used to do something.
  +
  +
=== Syntax ===
  +
  +
{{tlx|templatename}}
  +
  +
=== Parameters ===
  +
  +
;{{para|foo}} : purpose of foo
  +
  +
=== Examples ===
  +
  +
{{tlx|templatename}}
  +
  +
;produces…
  +
  +
{{templatename}}
  +
  +
  +
{{tlx|templatename|<var>foo</var>}}
  +
  +
;produces …
  +
  +
{{templatename|foo}}
  +
  +
=== See also ===
  +
  +
  +
<includeonly>
  +
Any categories for the template itself
  +
</includeonly>
  +
</pre>
  +
  +
Use any or all of the above description/syntax/sample output sections. You may also want to add “see also” or further usage information sections.
  +
  +
{{note}} The above example also uses [[:Template:Tlx]].
  +
<includeonly>
  +
[[Category:General wiki templates|{{PAGENAME}}]]
 
[[Category:Template documentation| ]]
  +
</includeonly><noinclude>
  +
[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 05:40, 16 September 2015

Description

Template:Documentation/doc is used to insert descriptions on template pages.

Syntax

<noinclude>{{documentation}}</noinclude>

at the end of the template page.

General usage

On the Template page

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>

Information icon4.svg Note: Depending on the template, you may need to insert the {{clr}} template (or complete a table/div) just before inserting <noinclude>{{documentation}}</noinclude>.

The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

<noinclude>{{documentation subpage}}</noinclude>
=== Description ===

'''{{FULLPAGENAME}}''' is used to do something.

=== Syntax ===

 {{tlx|templatename}}

=== Parameters ===

;{{para|foo}} : purpose of foo

=== Examples ===

 {{tlx|templatename}}

;produces…

{{templatename}}


{{tlx|templatename|<var>foo</var>}}

;produces …

{{templatename|foo}}

=== See also ===


<includeonly>
Any categories for the template itself
</includeonly>

Use any or all of the above description/syntax/sample output sections. You may also want to add “see also” or further usage information sections.

Information icon4.svg Note: The above example also uses Template:Tlx.