Template:For2/doc: Difference between revisions
More actions
←Created page with '{{TemplateBox |1 = 1 |1label = <!-- A (very) brief name for the parameter. --> |1d-en = <!-- English description of the first parameter the t...' |
add parameter documentation, use TemplateData |
||
| Line 1: | Line 1: | ||
{{TemplateBox | {{TemplateBox | ||
|1 = 1 | |1 = 1 | ||
|1label = | |1label = description | ||
|1d-en = | |1d-en = Description of the other page | ||
|1type = content | |||
|1type = | |||
|1def = <!-- default value for the parameter --> | |1def = <!-- default value for the parameter --> | ||
|1stat = required | |1stat = required | ||
|2 = 2 | |2 = 2 | ||
|2label = | |2label = link | ||
|2d-en = | |2d-en = Link to the other page (formatted as link) | ||
|2type = content | |||
|2type = | |||
|2def = | |2def = | ||
|2stat = required | |2stat = required | ||
|3 = lang | |||
|3label = language | |||
|3d-en = Fix the language of the template. Useful on translated pages | |||
|3type = line | |||
|3def = (user interface language) | |||
|3stat = optional- | |||
|name = For2 | |name = For2 | ||
| Line 34: | Line 37: | ||
|i18n-method = ext.translate | |i18n-method = ext.translate | ||
|print = | |print = | ||
|useTemplateData = only | |||
}}<includeonly> | }}<includeonly> | ||
[[Category:Disambiguation and redirection templates]]</includeonly> | [[Category:Disambiguation and redirection templates]]</includeonly> | ||
Latest revision as of 16:11, 22 May 2019
No description yet available.
Usage
{{For2 |1= |2= }}
Template parameters
- 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.
Wikipedia's help about TemplateData • Commons-specific information
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| description | 1 | Description of the other page | Content | required |
| link | 2 | Link to the other page (formatted as link) | Content | required |
| language | lang | Fix the language of the template. Useful on translated pages
| Line | optional |
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
Placement: At the top of the page
Example
{{For2|something|[[this page]]}}
renders as:
See also
Templates linking contents
"1-N" means from one to many.
Upwards links
- – "Main gallery" link from gallery or category to 1-N main galleries.
- – "Main category" link from gallery or category to 1-N main categories.
- – (box) Alternative "See category" boxed link from gallery to parent category, with explanation of the role of a gallery page.
Downwards links
- – "Further information" link to 1-N detailed galleries or categories.
Sideways page links
- – (box or inline) "See also" link to 1-N related pages.
- – "For" a single alternative page with explanation.
- – "For" 1-N alternative pages with one or more explanations.
- – As "For2" with an explanation of the current page.
- – As "For multi" with an explanation of the current page.
- – "Not to be confused with" link to 1-N related pages.
- – (box) Internationalized "See also" (or other caption) to related images.
- – (box) Internationalized with icon-links to related images of the same (medical) case.
- – "See" link from gallery to gallery.
Sideways category links
- – (box or inline) "See also Categories" link to 1-N related categories.
- – (box or inline) "Not to be confused with categories" link from category with ambiguous names to 1-N unrelated categories.
Interproject links
- – "Main Wikipedia article" link to 1 article (don't forget the purpose of interwiki links).
- – "See also Wikipedia article" link to 1-N articles (don't forget the purpose of interwiki links).
- Template:Multilingual link – allows to indicate names of versions of same Wikipedia article in many languages and displays one link in interface language.
Localization
العربية ∙ বাংলা ∙ català ∙ dansk ∙ Deutsch ∙ English ∙ Esperanto ∙ español ∙ فارسی ∙ suomi ∙ français ∙ हिन्दी ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ 한국어 ∙ македонски ∙ Bahasa Melayu ∙ norsk bokmål ∙ Nederlands ∙ norsk nynorsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Tiếng Việt ∙ 中文
This template makes use of {{Autotranslate}} and the translate extension.
