Template:Shared Template Warning/doc

From "PTTLink Wiki"
Jump to navigation Jump to search

This warning should be placed at the top of all templates and modules that are shared between wikis.

Usage

{{Shared Template Warning |1= }}

Template parameters

<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 TemplateDataCommons-specific information

This warning should be placed at the top of all templates and modules that are shared between wikis.

Template parameters

ParameterDescriptionTypeStatus
page name1

The full name of the shared template or module, as stored at mediawiki.org, including the namespace.

Example
Template:My_shared_template
Auto value
{{subst:NAMESPACE}}:{{subst:BASEPAGENAME}}
Pagerequired
translation table2

Optional title of the Commons data table with translations for this template or module, without the Data: prefix, and without the ".tab" suffix.

Example
My_shared_template
Auto value
{{subst:BASEPAGENAME}}
Stringsuggested
Originorigin

Custom origin. Supported values: “mw”/“MediaWiki” for MediaWiki (default), “c”/“Commons” for Wikimedia Commons, “m”/“Meta” for Wikimedia Meta-Wiki.

Default
MediaWiki
Stringoptional

Edit parameter translations

Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: no user group specified

Localization

This template is localized using Module:TNT. These translations are stored in Data:I18n/Shared Template Warning.tab.