Difference between revisions of "Template:Documentation"

From Northumberland Climbing
Jump to navigation Jump to search
Tag: 2017 source edit
Tag: 2017 source edit
Line 1: Line 1:
<noinclude>
 
 
</noinclude><includeonly>{{#switch:
 
| =
 
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}
 
| #default=
 
  {{#invoke:template=Template:Documentation|noshift=1}}
 
}}</includeonly><noinclude>
 
{{documentation|content=
 
  
 
{{Lua|Module:Documentation}}
 
{{Lua|Module:Documentation}}

Revision as of 02:32, 31 July 2020

This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.

It is intended for pages which are [[<tvar|1>Special:MyLanguage/Help:Transclusion</>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

Usage

Customizing display

Overrides exist to customize the output in special cases:

  • {{documentation|heading=}} - change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.


Rationale

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links.

It also reduces server resources by circumventing a technical limitation of templates (see a [[<tvar|1>:en:Special:Diff/69888944</>|developer's explanation]]).

See also

}}