Template:Module documentation

This template is i18n-ready, which means it is easy to localize for different languages. Please see I18n & l10n for templates to learn more.
See Template:Module documentation/l10n for the localization of this template.

Documentation The documentation below is transcluded from Template:Module documentation/doc. (edit | history)

[purge]

This template outputs a documentation wrapper very similar to the one generated by {{doc}}, but adjusted for modules. It is used on MediaWiki:Scribunto-doc-page-show and MediaWiki:Scribunto-doc-page-does-not-exist, which are the system messages displayed above the module code on a module page.

The template is not intended for direct transclusion on the wiki anywhere! Due to being included on the MediaWiki pages, it is transcluded automatically on all module pages, displaying the content of that module's documentation subpage wrapped in the documentation box.

Usage

The template is intended to be used on the two MediaWiki pages in the following way:

Intended content of MediaWiki:Scribunto-doc-page-show:

{{module documentation|$1|exists=yes}}
<hr id="module-code"/>

Intended content of MediaWiki:Scribunto-doc-page-does-not-exist:

{{module documentation|$1|exists=no}}
<hr id="module-code"/>

The first unnamed parameter is the page name of the module documentation. The exists parameter causes a slight adjustment in output.