A Wiki in the Desert
Log in

Template:Documentation

From A Wiki in the Desert
Revision as of 22:32, 12 July 2018 by Brad (talk | contribs) (Created page with "<includeonly><div style="border: 1px solid darkgray; margin: 3em 1em 1em;"><div style="background: #f8f9fa; color: Black; padding: 1em; margin: 0;">'''Template documentation''...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Template documentation (for the above template, sometimes hidden or invisible)

{{Documentation}} formats and displays documentation subpages.

Usage

{{Documentation
| namespace = 
}}
namespace (optional)
If a documented page's namespace isn't Template, enter it here.

This template transcludes the contents of the page's /doc subpage. If the page doesn't exist, it displays a red link to the page.

Example

On a Template page

<includeonly>(Template code)</includeonly><noinclude>
[[Category:Relevant template categories]]
{{Documentation}}
</noinclude>

Note that, depending on the template, you may need to add {{Clear}} or close any open <table> or <div> tags in the template before the {{Documentation}} template.

On a page in any other namespace

(Content)<noinclude>
{{Documentation|namespace=NamespaceName}}
</noinclude>

The namespace parameter lets you add documentation to pages on any namespace.

On the Template/doc page

'''{{tl|Thistemplate}}''' is a template that (describe the template).

== Usage ==
<pre>
(Template usage and parameters)
</pre>

; parameter ''(optional)'': Describe each parameter, and note whether it's optional and has a default value.

== Example ==
<pre>
(Example template usage)
</pre>

produces 

(Example template usage)

Use any or all of the above description, usage, and example sections. You can also add "see also" or further usage information sections.