Difference between revisions of "Template:Documentation"

From Bronies.wiki
Jump to navigation Jump to search
(Created page with "<div id="template-documentation" class="template-documentation"> == Documentation == :''This documentation is transcluded from [[Template:{{PAGENAME}}/doc]] and needs to be <s...")
 
(Remove documentation heading.)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<div id="template-documentation" class="template-documentation">
+
<div id="template-documentation" class="box blue">
== Documentation ==
+
: ''This documentation is transcluded from [[Template:{{PAGENAME}}/doc]] and needs to be <span class="plainlinks">[{{fullurl:Template:{{PAGENAME}}/doc|action=edit}} edited separately]</span>.
:''This documentation is transcluded from [[Template:{{PAGENAME}}/doc]] and needs to be <span class="plainlinks">[{{fullurl:Template:{{PAGENAME}}/doc|action=edit}} edited separately]</span>.
 
 
{{:Template:{{PAGENAME}}/doc}}
 
{{:Template:{{PAGENAME}}/doc}}
 
__NOEDITSECTION__
 
__NOEDITSECTION__

Latest revision as of 01:43, 4 October 2020

This documentation is transcluded from Template:Documentation/doc and needs to be edited separately.

This template is intended for documenting templates and other pages that are transcluded onto other pages. It can be used in the template namespace and most other namespaces.

Keeping documentation separate from template code allows for a separation of concerns: templates are complex, typically requiring advanced knowledge of wikitext and ParserFunctions, whereas documentation is intended to be human-readable prose. It also allows for templates to be protected without affecting the ability to document it.

Usage

{{Documentation}}

There are no parameters.

This template should never be substituted in normal use.