Difference between revisions of "Template:TemplateBox/doc"

From "PTTLink Wiki"
Jump to navigation Jump to search
Mediawiki>ExE Boss
(Enable and improve documentation for `i18n‑method=TNT` and the `i18n‑data‑file` parameter)
 
(Created page with "{{Shared Template Warning|Template:TemplateBox|origin=Commons}} <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> {{#ifeq:{{SUBPAGE...")
(No difference)

Revision as of 19:36, 20 January 2022

warning Warning:Do not edit. This page is maintained by an automated tool. All edits should be done at commons.wikimedia.org. (translate this warning)

The template provides a uniform way to provide basic information about the use of a template. See: Commons:Template documentation and Commons:TemplateData.

Usage

{{TemplateBox
 |1                  =
 |1d                 =
 |1d-td              =
 |1type              =
 |1def               =
 |1stat              =
 |useTemplateData    =
 |name               =
 |desc               =
 |namespace          =
 |usergroup          =
 |placement          =
 |usage-notes        =
 |type               =
 |example            =
 |example-value      =
 |i18n-method        =
 |i18n-desc          =
 |i18n-mediawiki-msg =
 |i18n-subpage       =
 |i18n-data-file     =
 |seealso            =
 |setscats           =
 |print              =
 |shorthand          =
 |relieson           =
 |mustbesubst        =
 |docsub-page        =
}}

Template parameters

ParameterDescriptionDefaultStatus
1name (param)parameter name (similarly 2, 3, …). Note that if all of the parameters beginning with a number are removed from the template, the usage notes will state "The template takes no parameters."emptyoptional
1d
1d-en
1description
1description-en
description (param)description of the parameter (similarly 2d, 3d, …) -langcodeemptyoptional
1d-td
1d-td-en
1description-td
1description-td-en
TemplateData description (param)description of the parameter (similarly 2d-td, 3d-td, …) for Extension:TemplateData which does not accept Wiki-markup. If this parameter is omitted, 1d is used. You can always override the defaults specifically for TemplateData by appending -td to the parameter-name. You can specify a language by appending your language-code. E.g. 3d-td-en would be the English translation of the description of parameter 3 which will be used in TemplateData. -langcodeemptyoptional
1label
1label-en
1label-td
1label-td-en
label (param)A (very) brief name for the parameter. Try to keep under 20-ish characters. 1label-de would be the German translation of this label. -langcodeemptyoptional
1aliasesaliases (param)List of aliases. An alias is an alternative name for the parameter that may be used instead of (not in addition to) the primary name. Separate them by / (a slash)emptyoptional
1typetype (param)The type of the parameter, for (soft) type hinting. Please refer to the list of possible values.emptyoptional
1setset (param)Label and ID of a set in one. Multiple parameters can be grouped in a set, if either none or all of them must be supplied. Try to keep under 20-ish characters.emptyoptional
1def
1def-td
1default
default (param)default value for the parameter (similarly 2def, 3def, …) -langcodeemptyoptional
1stat
1stat-td
1deprecated
1required
status (param)status of the parameter (similarly 2stat, 3stat, …); possible values:
required[clarification needed]
optional
optional-
optional and not present in the standard form
deprecated
optionaloptional
useTemplateDataexpose TemplateDataWhether the template should expose TemplateData - omitting means "false". Setting to 1, true, or yes means "true". Setting to only will suppress the house-made table. Setting useTemplateData to export will turn TemplateBox into a preformatted Copy & Paste template. Seting to TNT or TNT:template name will cause TemplateData to be handled handled by Module:TNT.emptysuggested
nametitle (template)name of the template (needed for viewing the documentation on another page than the template page, in particular for viewing the documentation page separately){{BASEPAGENAME}}required
desc
desc-en
description
description-en
desc-td
description-td
description (template)description of what the template does -langcodeemptyrequired
namespacenamespacenamespaces, the template is intended to be used in; possible values:
all
talks
contents
Main
Talk
User
User talk
Commons
Commons talk
File
File talk
MediaWiki
MediaWiki talk
Template
Template talk
Help
Help talk
Category
Category talk
Creator
Creator talk
Special
Any other values will show as “unknown”.
no namespace specifiedrequired
usergroupusergroupusergroup that is meant to use the template; possible values:
all
bot
administrator
admin
sysop
bureaucrat
crat
checkuser
licensereviewer
vrt
autoconfirmed
autopatrolled
filemover
oversight
patroller
rollbacker
steward
upwizcampeditors
no user group specifiedrequired
placementplacementplacement on the page. Possible values:
top
bottom
licence
source
emptyoptional
usage-notesusage-notesnotes about the correct usage of the templateemptyoptional
typetype (template)what type is the template (infobox, formatting, licence tag, …)emptyoptional
exampleexampleExample use (works with a single unnamed parameter only). There is also example2 for a second example.emptyoptional
example-valueexample-resultIf there is more than one parameter you would like to show or if there are named parameters, use:
{{TemplateBox
 |name=SampleTemplate
 |example=param1=value1{{!}}param2=value2
 |example-value={{SampleTemplate
   |param1=value1
   |param2=value2
   |category=
 }}
}}
emptyoptional
i18n-methodtranslation methodmethod the localization is achieved by. Known values:
autotranslate
using {{autotranslate}} or applying a similar method
switch
using {{LangSwitch}} in the template itself
-
no localization needed
custommediawiki-msg
using MediaWiki namespace messages
mediawiki-msg
using MediaWiki namespace messages, translated on translatewiki.net
ext.translate
using {{autotranslate}} or applying a similar method on a subpage that is marked for translation using the translate extension
TNT
Using Module:TNT and a tabular translations file on Wikimedia Commons.
emptyoptional
i18n-desctranslation infoadditional info about the localizationemptyoptional
i18n-mediawiki-msgmediawiki-messageWhen using “mediawiki-msg” as method, optionally put the name of the message here. Falls back to:emptyoptional
i18n-subpagetranslation-subpageWhen using “ext.translate” as method, optionally put the name of the sub-page here. A dot (.) means that the current template hosts the translation on its subpages directly.i18noptional
i18n-data-fileI18n Data FileThe tabular data file on Wikimedia Commons in the Data namespace. The I18n/ prefix and the .tab file extension are added automatically if its missing.I18n/{{{name}}}.taboptional
seealsosee alsorelevant links (put in a list of them)emptyoptional
setscatscategorizes intowhat categories are automatically set by the template (put in a linked list of them)emptyoptional
printprintThe way the parameters are typically arranged (horizontally or vertically). Possible values: multi - parameters arranged in multiple lines; one - one line; infobox - multiple lines and space padding in front of the =.one (if type param ≠ infobox)optional
lines
print
Use parameter print instead.emptyoptional
shorthandshorthandshorthand for easy use (redirects to main template). See examples here and here of lists of redirects, and searches for more.emptyoptional
reliesonrelies onlist of templates on which the template's basic functionality reliesemptyoptional
mustbesubstmust be substSet to "yes" (or any value) if the template must be substituted. This puts "subst:" into the template example under "usage".emptyoptional
docsub-page{{Documentation subpage}} page parameter{{NAMESPACE}}:{{BASEPAGENAME}}optional
<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

Unexpected property "params.1stat.suggestedvalues".

Additional information

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

The template is intended to be used by the following user groups: all users

Placement:

in the '/doc' subpage of a template

Relies on:

⧼Seealso⧽

Localization

Boarisch  català  Bahasa Indonesia  Deutsch (Sie-Form)  dansk  čeština  Canadian English  Deutsch  Bahasa Melayu  sicilianu  italiano  русский  eesti  беларуская (тарашкевіца)  Tiếng Việt  português  euskara  English  magyar  Zazaki  Nederlands  português do Brasil  Türkçe  slovenščina  polski  latviešu  galego  slovenčina  македонски  norsk bokmål  Lëtzebuergesch  español  svenska  hrvatski  français  suomi  Plattdüütsch  occitan  norsk nynorsk  српски / srpski  українська  मराठी  বাংলা  ਪੰਜਾਬੀ  മലയാളം  ไทย  한국어  日本語  中文  中文(简体)  中文(繁體)  العربية  فارسی  +/−

This template makes use of {{Autotranslate}} and the translate extension. The layout of the template can be found under Template:TemplateBox/layout.

48pxTranslate this template now!
 Administrate translations.

About: TemplateData

{{Commons:TemplateData}}

Complications

( NOTE : the {{sed|1}} template links appears HERE : >>> )

edit

A complication is that the template suppresses section editing links on the whole page of the documented template, and also on its documentation page, even for paragraphs outside the part produced by this template TemplateBox. Template:Sed can be used (as is done here) to create an edit link anyway.