Difference between revisions of "Template:Format TemplateData/doc"

From blackwiki
Jump to navigation Jump to search
imported>GKFX
(Add {{lua}})
imported>GKFX
(→‎Usage: Move formatting options section into table.)
Line 6: Line 6:
 
     "JSON": {
 
     "JSON": {
 
         "label": "JSON template information",
 
         "label": "JSON template information",
             "description": "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.",
+
             "description": "The code that would normally be wrapped in [[WP:TemplateData|&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. You should use HTML entities for special characters such as &lt;&gt;. <noexport><h3>Formatting options</h3>
 +
*'''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 &#91;https:&#47;&#47;en.wikipedia.org Wikipedia&#93;, this will appear as [https://en.wikipedia.org Wikipedia] in the table and https:&#47;&#47;en.wikipedia.org in VisualEditor.
 +
*'''[[HTML entities]]''': you may specify &amp;lt; &amp;gt; &amp;amp; &amp;quot; &amp;nbsp; and any numeric entity.
 +
*'''HTML tags''' may be used; they won't appear in VisualEditor.
 +
*'''&lt;noexport&gt;&lt;/noexport&gt;''' 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.</noexport>",
 
             "required": true,
 
             "required": true,
 
             "type": "string",
 
             "type": "string",
Line 27: Line 33:
 
"description": "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|TemplateDataHeader}} is automatically inserted before the table."
 
"description": "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|TemplateDataHeader}} 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 <nowiki>[https://en.wikipedia.org Wikipedia]</nowiki>, this will appear as [https://en.wikipedia.org Wikipedia] in the table and <nowiki>https://en.wikipedia.org</nowiki> 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 &amp;lt; &amp;gt; &amp;amp; &amp;quot; &amp;nbsp; and any numeric entity.
 
*'''HTML tags''' may be used; they won't appear in VisualEditor.
 
*'''&lt;noexport&gt;&lt;/noexport&gt;''' 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.
 
  
 
<includeonly>{{sandbox other||
 
<includeonly>{{sandbox other||

Revision as of 14:33, 20 January 2018

Usage

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Format TemplateData

INTERNAL: mw.text.jsonDecode: Control character error, possibly incorrectly encoded