Commons:TemplateData

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

---

Wikipedia's help about TemplateData • Commons-specific information

Using TemplateBox

Every entity, except inherit that is documented at the TemplateData technical documentation, is supported by {{TemplateBox}}. Conversion to JSON is done by a LUA module. The LUA module automatically converts traditionally used parameters as well as the new ones to both, TemplateData, as well as the "historic table", on demand. The "historic table" is the table which was used to show parameter information at Wikimedia Commons before TemplateData was invented.

Required parameters

• |desc=, parameters and their description

Translation

• Avoid {{LangSwitch}}. It doesn't work in TemplateData.
• Append -langcode to the name of any translatable parameter, marked by ^-langcode in TemplateBox. For example, adding the French translation of the description of parameter 1, you would write |1d-fr=C'est la description pour paramètre un.. Supplying only |1d-en=This is the description of parameter 1. instead of |1d=This is the description of parameter 1. will also work. It is recommended to be used if you want to ease the job for translators (because they then recognize the structure behind it without having to consult the documentation).
• The language code must be the last element. Valid: |1d-td-en=. Invalid: |1d-en-td=

Naming

• Both, old names and new names are supported but treated differently if both of them are supplied.
  • For example, while creating the "historic table", if both 1def and 1default where supplied, the value for 1def would be used. For generating TemplateData, the preference is the other way around.

Overriding

• It's possible to override a specific entity, either for the "historic table" or for TemplateData.
  • To override for TemplateData, append a -td to the parameter's default name.
  • On the other hand, if you coded something for TemplateData and want to use a link or other markup in the "historic table", use the parameter name without the -td or modify that, which should be only used for TemplateData appending -td.

Pay attention

• TemplateData does not support parsing Wiki-Markup. Think of it as if it would expand all templates and finally putting a nowiki around all this.
• When including templates, they must be wrapped them in <nowiki>s.
• Even though some tags, such as <pre> seem to be rendered as expected, avoid them.

Activation

• TemplateData can be activated setting the useTemplateData parameter to 1 or to only. The former will add a collapsed version of the table; the latter one replaces the "historic table" with the TemplateData table. In both cases, TemplateData is available through the API.

Fetching TemplateData (e.g. for TemplateBox itself)

/w/api.php?action=templatedata&format=json&titles=Template%3ATemplateBox (raw result, pretty result)

Advantages

• No type-mixture: Instead of inserting a new content-type, a template can be used.
• Syntax: Less error-prone compared to editing JSON (without a special editor).
• Schema: Always valid. TemplateBox always passes a structure matching the requested schema.
• Flat structure.
• Prepared for future changes. Adjustments to the LUA module can be made to support future changes. The power of control remains at Commons.
• Inserting redundant information can be avoided.
• Template traditionally used at Commons.

Issues

• Grouping sets is currently not supported in the "historic table".

Example

{{TemplateBox
  |desc-de=    Deutsche Übersetzung der {{tl|Vorlagen}}beschreibung
  |desc-en=    English translation of the {{tl|template}} description
  |desc-td-en= English translation that would be used in TemplateData instead of "desc-en". 
This will also remove the German translation in TemplateData (unless supplied as "desc-td-de") 
as it is assumed that it contains improper markup.
  |useTemplateData = 1
}}