Jump to content

Template:Documentation/doc: Difference between revisions

From The Petit Planet Wiki
ReisuDesign (talk | contribs)
Created page with "{{Documentation/Header}} {{Lua|Documentation}} {{CSS|Gadget-Documentation}} This template is used to insert documentation to template pages. ==Syntax== * {{T|Documentation}} will produce the documentation template. * {{T|Documentation|foo}} will fill in the documentation from the "<code>foo</code>" template. * {{T|Documentation|p1=content=This template does something}} will fill in the documentation with the content "<code>This template does something</code>." (not reco..."
 
ReisuDesign (talk | contribs)
No edit summary
 
Line 1: Line 1:
{{Documentation/Header}}
{{Documentation/Header}}
{{High Risk}}
{{Lua|Documentation}}
{{Lua|Documentation}}
{{CSS|Gadget-Documentation}}
{{CSS|Gadget-Documentation}}

Latest revision as of 11:24, 12 September 2026

This is the documentation page for Documentation.
It contains usage information, categories, and other content not part of the original template page.
This template is used on 294 pages, or on about 2.81% of all pages.
Edits to this template will be widely noticed. To avoid large-scale disruption and unnecessary server load, any changes to this template should be tested in its sandbox or testcases subpages, or in your own user space. The tested changes can then be added to this page in one single edit.
Please consider discussing any changes in the wiki's Discord.
This template uses Module:Documentation, a script written in Lua.
This template uses CSS found at MediaWiki:Gadget-Documentation.css.

This template is used to insert documentation to template pages.

Syntax

[edit source]
  • {{Documentation}} will produce the documentation template.
  • {{Documentation|foo}} will fill in the documentation from the "foo" template.
  • {{Documentation|content = This template does something}} will fill in the documentation with the content "This template does something." (not recommended except for very, very short documentation)
  • {{Documentation|heading = Important information}} will replace the default heading with "Important information".
  • {{Documentation|type = category}} will add the "category Templates" category.

Template Data

[edit source]

This template is used to insert descriptions on template pages.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Custom Documentation Page1

Page containing the documentation

Default
{{FULLPAGENAME}}/doc
Page nameoptional
Headingheading

Custom heading

Default
[[File:Template-icon.svg|50px|link=|alt=Documentation icon]] Documentation
Lineoptional
Preload Pagepreload

The page to preload if the `/doc` subpage doesn't exist.

Default
Template:Documentation/preload
Page nameoptional
Contentcontent

Custom documentation content, prevents transclusion of `/doc` subpage.

Contentoptional
Typetype

Category to categorize template in.

Stringsuggested