Module:TemplateDataDoc/doc

This is a documentation subpage for Module:TemplateDataDoc.
It contains usage information, categories and other content that is not part of the original Module page.

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

Warning:

This page is shared between multiple wikis.
All changes to this page will be automatically copied to all wikis listed in the left side bar.
To avoid unnecessary page regeneration and server load, changes should be tested on the page's sandbox.

Usage

This module automatically generates blocks of template documentation page using TemplateData.

{{#invoke:TemplateDataDoc|generateBlank}} — generates blank template wikitext
{{#invoke:TemplateDataDoc|generateExample}} — generates template example wikitext and shows how a template with such parameters will be displayed

For correct order of parameters, TemplateData should contain paramOrder block.