Template:Format TemplateData/doc

This is a documentation subpage for Template:Format TemplateData.
It may contain usage information, categories and other content that is not part of the original template page.

Usage

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Format TemplateData in articles based on its TemplateData.

TemplateData for Format TemplateData

fatal JSON error: mw.text.jsonDecode: Syntax error

{
	"params": {
    	"JSON": {
        	"label": "JSON template information",
            "description": "The code that would normally be wrapped in &lt;templatedata&gt; tags (not including the &lt;templatedata&gt; tags themselves. Links and basic text formatting should just work in the displayed table; see this template's page for full details.",
            "required": true,
            "type": "string",
            "aliases": ["1"]
        },
        "TOC": {
            "label": "Show table of contents",
            "description": "If set to 1, inserts a table of contents for the whole page just after the description and before any parameter table.",
            "type": "boolean",
            "default": "0",
            "suggested": true
        },
		"header": {
			"label": "Show TemplateDataHeader",
			"description": "If set to 0, hides the TemplateDataHeader template. This is not generally recommended.",
			"type": "boolean",
            "default": "1"
		}
	},
	"description": "This template formats TemplateData nicely on doc pages. It hides irrelevant information such as \"Default: empty\", and allows the use of formatting. Remember that the users of VisualEditor '''will not see''' this formatting; it is important to test your new TemplateData in VisualEditor to check that it makes sense without. (For all details of formatting available, see the template's page.) By default, <span class="nowrap">&#123;&#123;</span>TemplateDataHeader<span class="nowrap">&#125;&#125;</span> is automatically inserted before the table."
}

Formatting options

Wikilinks can be specified in the usual way. They will only work in the table; in VisualEditor, the title of the link will be displayed as plain text.
External links can be specified by just inserting the URL; this will be clickable in the table and viewable in VisualEditor. If the URL is specified as [https://en.wikipedia.org Wikipedia], this will appear as Wikipedia in the table and https://en.wikipedia.org in VisualEditor.
Bold and italics can be specified with apostrophes in the normal way. The text will be unformatted in VisualEditor.
HTML entities: you may specify < > & "   and any numeric entity.
HTML tags may be used; they won't appear in VisualEditor.
<noexport></noexport> Content wrapped in these tags will appear only in the table. It will not appear in VisualEditor at all; it is useful for detailed explanations of parameters, and for content that is only useful with formatting. Newline characters are respected here.
Templates may be transcluded. However some templates may output content that makes the JSON invalid.