Difference between revisions of "Template:Format TemplateData/sandbox"
imported>GKFX (Use sandboxed module version.) |
imported>GKFX (Subst further) |
||
| Line 1: | Line 1: | ||
{{#ifeq:{{yesno-yes|{{{header}}}}}|yes|{{TemplateData header}}}} | {{#ifeq:{{yesno-yes|{{{header}}}}}|yes|{{TemplateData header}}}} | ||
<includeonly>{{#invoke:TemplateData/sandbox| f |classNoNumTOC=nonumtoc |cssParams=border:#B3B7FF 1px solid;|docpageCreate=%s/doc |docpageDetect=/doc$ |msgDescMiss=Beschreibung fehlt |cat=Wikipedia:Vorlagenfehler/Vorlage:TemplateData}}</includeonly><noinclude>Usage information appears here.</noinclude><noinclude> | <includeonly>{{#invoke:TemplateData/sandbox| f |classNoNumTOC=nonumtoc |cssParams=border:#B3B7FF 1px solid;|docpageCreate=%s/doc |docpageDetect=/doc$ |msgDescMiss=Beschreibung fehlt |cat=Wikipedia:Vorlagenfehler/Vorlage:TemplateData}}</includeonly><noinclude>Usage information appears here.</noinclude><noinclude> | ||
| − | {{# | + | <div style="clear: both;"></div><table class="plainlinks ombox ombox-notice" role="presentation"><tr><td class="mbox-image">[[Image:Sandbox.svg|50px|alt=|link=]]</td><td class="mbox-text">This is the [[Wikipedia:Template test cases|template sandbox]] page for [[Template:Format TemplateData]] ([//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Template%3AFormat+TemplateData&page2=Template%3AFormat+TemplateData%2Fsandbox diff]).[[Category:Template sandboxes]]</td></tr></table><div id="template-documentation" class="template-documentation iezoomfix"> |
| + | <div style="padding-bottom:3px;border-bottom:1px solid #aaa;margin-bottom:1ex"> | ||
| + | <span style="font-weight:bold;font-size:125%">[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]] Template documentation</span><span class="mw-editsection-like plainlinks" id="doc_editlinks">[[[Template:Format TemplateData/doc|view]]] [[//en.wikipedia.org/w/index.php?title=Template:Format_TemplateData/doc&action=edit edit]] [[//en.wikipedia.org/w/index.php?title=Template:Format_TemplateData/doc&action=history history]] [[//en.wikipedia.org/w/index.php?title=Template:Format_TemplateData/sandbox&action=purge purge]]</span></div> | ||
| + | {{ Template:Format TemplateData/doc}} | ||
| + | <div style="clear:both"> | ||
| + | </div></div><table id="documentation-meta-data" class="plainlinks fmbox fmbox-system" role="presentation" style="background-color: #ecfcf4"><tr><td class="mbox-text" style="font-style: italic">The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[Template:Format TemplateData/doc]]. <small style="font-style: normal;">([//en.wikipedia.org/w/index.php?title=Template:Format_TemplateData/doc&action=edit edit] | [//en.wikipedia.org/w/index.php?title=Template:Format_TemplateData/doc&action=history history])</small><br />Editors can experiment in this template's [[Template:Format TemplateData/sandbox|sandbox]] <small style="font-style: normal;">([//en.wikipedia.org/w/index.php?title=Template:Format_TemplateData/sandbox&action=edit edit] | [//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Template%3AFormat+TemplateData&page2=Template%3AFormat+TemplateData%2Fsandbox diff])</small> and testcases <small style="font-style: normal;">([//en.wikipedia.org/w/index.php?title=Template:Format_TemplateData/testcases&action=edit&preload=Template%3ADocumentation%2Fpreload-testcases create])</small> pages.<br />Please add categories to the [[Template:Format TemplateData/doc|/doc]] subpage. [[Special:PrefixIndex/Template:Format TemplateData/|Subpages of this template]].</td></tr></table> | ||
</noinclude> | </noinclude> | ||
Revision as of 20:44, 6 February 2018
TemplateData for Format TemplateData
Usage information appears here.
| This is the template sandbox page for Template:Format TemplateData (diff). |
| This template uses Lua: |
Everything below this line is a demo of Format TemplateData: read the source code, and expand the raw TemplateData section, to see how it all works.
Usage
TemplateData for Format TemplateData
This template formats [[WP:VE/TD|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, {{tl|TemplateData header}} is automatically inserted before the table.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| <templadata> template information | 1 | If the JSON parameter is not specified, this will be processed to extract the JSON. This option allows you to use the GUI TemplateData Editor, but it's a bit wonkier than giving the actual JSON object directly.
| String | optional |
| JSON template information | JSON | The code that would normally be wrapped in [[WP:TemplateData|<templatedata>]] tags (not including the <templatedata> tags themselves. Links and basic text formatting should just work in the displayed table; see this template's page for full details. You should use HTML entities for special characters such as <>. <noexport><h3>Formatting options</h3>
| String | suggested |
| Show table of contents | TOC | If set to 1, inserts a table of contents for the whole page just after the description and before any parameter table.
| Boolean | suggested |
| Show TemplateDataHeader | header | If set to 0, hides the TemplateDataHeader template. This is not generally recommended.
| Boolean | optional |
| Prevent TemplateData output | lazy | If set, other than to 0, prevents any real TemplateData being produced. Potentially useful if there are multiple instances of this template on a page but only one should be active. To clarify, this means that this template will ''not'' be understood by VisualEditor.
| Boolean | optional |
Using the template
Add the <templatedata> as usual, and then enclose it in a template call like {{Format TemplateData|1=<templatedata>...</templatedata>}}.
Maintenance categories
- Category:Templates with TemplateData errors (0) – the template adds this category to template documentation pages with malformed TemplateData code.
| The above documentation is transcluded from Template:Format TemplateData/doc. (edit | history) Editors can experiment in this template's sandbox (edit | diff) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |