Template:documentation

From HausaDictionary.com | Hausa English Translation, Dictionary, Translator
Jump to: navigation, search
Template documentation[view] [edit] [history] [purge]

This template is used to show the documentation of the template or a module that is stored in the /doc subpage and wraps a green box around it depending on the namespace of the page using the template.

Usage

On any page, this template is best used using the following syntax:

<!-- Your template code --><noinclude>
{{documentation}}
<!-- Categories, interwikis and TemplateData goes to the /doc subpage -->
</noinclude>

The documentation page is then created through the links provided by the template when the page is saved. If a /doc subpage exists, this template will transclude it accordingly with the respective categories and TemplateData documentation if the page is in the Template: namespace.

Technical notes

This template invokes Module:Documentation and passes given parameters over to it. The module is the main place where the processing and formatting of the page is done.

TemplateData

This is the TemplateData documentation for the template used by the new VisualEditor.

Documentation

<templatedata> { "params": { "1": { "required": false, "label": "Documentation page", "type": "string/wiki-page-name", "description": "The page holding the documentation, if not in the default /doc subpage.", "aliases": [ "docpage" ] }, "sandbox": { "required": false, "label": "Sandbox page", "description": "The sandbox page to link to.", "type": "string/wiki-page-name" }, "testcases": { "required": false, "label": "Testcases page", "description": "The testcases page to link to.", "type": "string/wiki-page-name" }, "heading": { "type": "string", "label": "Heading", "description": "A custom heading to use instead of the defaults. Use \"off\" for this parameter to disable the heading text." }, "content": { "type": "string", "label": "Content", "description": "Contents to put in the documentation box, used to put documentation on the template page itself." } }, "description": "A template to display documentation from the /doc subpage." } </templatedata>