Jump to content

සැකිල්ල:Format TemplateData/ලේඛය

විකිපීඩියා වෙතින්

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[සංස්කරණය]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Format TemplateData

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, {{tl|TemplateData header}} is automatically inserted before the table.
JSON template informationJSON
The code that would normally be wrapped in <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 <>.

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.
  • HTML entities: you may specify &lt; &gt; &amp; &quot; &nbsp; 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.
Default
If neither {{{1}}} nor {{{JSON}}} is given, the page's source code is scanned for a <templatedata> tag.
<templadata> template information1
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.
Default
See {{{JSON}}}.
Show table of contentsTOC
If set to 1, inserts a table of contents for the whole page just after the description and before any parameter table.
Default
0
Show TemplateDataHeaderheader
If set to 0, hides the TemplateDataHeader template. This is not generally recommended.
Default
1
Prevent TemplateData outputlazy
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.
Default
0

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, {{tl|TemplateData header}} is automatically inserted before the table.

Template parameters

ParameterDescriptionTypeStatus
JSON template informationJSON

The code that would normally be wrapped in <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 <>.

Default
If neither {{{1}}} nor {{{JSON}}} is given, the page's source code is scanned for a <templatedata> tag.
Stringsuggested
template information1

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.

Default
See {{{JSON}}}.
Stringoptional
Show table of contentsTOC

If set to 1, inserts a table of contents for the whole page just after the description and before any parameter table.

Default
0
Booleansuggested
Show TemplateDataHeaderheader

If set to 0, hides the TemplateDataHeader template. This is not generally recommended.

Default
1
Booleanoptional
Prevent TemplateData outputlazy

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.

Default
0
Booleanoptional

Using the template[සංස්කරණය]

Add the <templatedata> as usual, and then enclose it in a template call like {{Format TemplateData|1=<templatedata>...</templatedata>}}.

Maintenance categories[සංස්කරණය]


"https://si.wikipedia.org/w/index.php?title=සැකිල්ල:Format_TemplateData/ලේඛය&oldid=458729" වෙතින් සම්ප්‍රවේශනය කෙරිණි