This is a documentation subpage for Template:Transwiki guide. It may contain usage information, categories and other content that is not part of the original template page. |
This adds a tag to the top of a template documentation page indicating that the template has a transwiki guide. It automatically includes pages it is transcluded on in Category:Transwiki guide. If the template has a documentation page, you should add it inside <includeonly>...</includeonly>
tags at the top.
Will automatically detect if used on a template or module and change the name as appropriate, other namespaces or pages can use the |type=
to change the term.
Will automatically link to a transwiki guide at the location [[{{FULLPAGENAME}}/Transwiki guide]]
. (Despite this template being placed on the documentation page, for example on Template:Example/doc, the transwiki guide should not be under the /doc subpage, but as a subpage under the template, as the automatic link will for for example link to Template:Example/Transwiki guide despite being placed in Template:Example/doc as Template:Example/doc is transcluded to Template:Example when the notice is viewed.)
{{Transwiki guide candidate}} can be added to templates which are good candidates for having a transwiki guide.
Syntax
Basic
{{transwiki guide}}
All parameters
{{transwiki guide|page|category sort|small=yes}}type=project}}
TemplateData
TemplateData for Transwiki guide
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Transwiki page override | 1 | no description
| Page name | optional |
Sort key | 2 | A custom sort key for [[:Category:Transwiki guide]]
| String | optional |
Small ombox | small | no description
| Boolean | optional |
Complete text override | text | no description | Content | deprecated |