Actions

Template

Difference between revisions of "Documentation"

(Fixed)
Line 9: Line 9:
 
  {{{usageExample}}}
 
  {{{usageExample}}}
 
</div>
 
</div>
 +
The above would render the following:
 +
{{{usageResult}}}
 
== Parameters: ==
 
== Parameters: ==
 
{{{parameters}}}
 
{{{parameters}}}
Line 19: Line 21:
 
| usageContent  = To use this template simply fill in the parameters (they are all mandatory).
 
| usageContent  = To use this template simply fill in the parameters (they are all mandatory).
 
| usageExample  =
 
| usageExample  =
<nowiki>{{Documentation
+
<nowiki>
 +
{{Documentation
 
| title        = The documentation title
 
| title        = The documentation title
 
| introduction  = The introduction section
 
| introduction  = The introduction section
 
| usageContent  = The section explaining how to use it
 
| usageContent  = The section explaining how to use it
 
| usageExample  = A wikitext example of how to use the template. This would get very meta if I included more here...
 
| usageExample  = A wikitext example of how to use the template. This would get very meta if I included more here...
}}</nowiki>
+
| usageResult
 +
}}
 +
</nowiki>
 +
| usageResult  = Putting the actual stuff here kinda breaks the page...
 
| parameters    = <templatedata>
 
| parameters    = <templatedata>
 
{
 
{

Revision as of 23:31, 13 October 2020


Documentation (Meta)

This template should be used to add information about how to use templates (such as how it's being used here, meta!).

Usage:

To use this template simply fill in the parameters (they are all mandatory).

{{Documentation
| title         = The documentation title
| introduction  = The introduction section
| usageContent  = The section explaining how to use it
| usageExample  = A wikitext example of how to use the template. This would get very meta if I included more here...
| usageResult
}}

The above would render the following: Putting the actual stuff here kinda breaks the page...

Parameters:

Here you can put in information about parameters

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Titletitle

The template title

Stringrequired
Introductionintroduction

Explains the motivation for this template

Contentrequired
UsageContentusageContent

The usage section

Unbalanced wikitextrequired
CodeusageExample

Usage code block

Unbalanced wikitextrequired
Parametersparameters

The TemplateData

Unknownrequired