View source for Template:Transwiki guide/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

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 {{tag|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 {{para|type}} to change the term.

Will automatically link to a transwiki guide at the location <syntaxhighlight lang=wikitext inline>[[{{FULLPAGENAME}}/Transwiki guide]]</syntaxhighlight>. (Despite this template being placed on the documentation page, for example on {{fake link|Template:Example/doc}}, the transwiki guide should not be under the {{mono|/doc}} subpage, but as a subpage under the template, as the automatic link will for for example link to {{fake link|Template:Example/Transwiki guide}} despite being placed in {{fake link|Template:Example/doc}} as {{fake link|Template:Example/doc}} is transcluded  to {{fake link|Template:Example}} when the notice is viewed.)

{{tl|Transwiki guide candidate}} can be added to templates which are good candidates for having a transwiki guide.

== Syntax ==

'''Basic'''

 &#123;&#123;transwiki guide&#125;&#125;

'''All parameters'''

 &#123;&#123;transwiki guide&#124;''page''&#124;''category sort''&#124;small=''yes''&#125;&#125;type=''project''&#125;&#125;

== TemplateData ==
{{TemplateData header}}

<templatedata>
{
	"params": {
		"1": {
			"label": "Transwiki page override",
			"type": "wiki-page-name",
			"default": "{{FULLPAGENAME}}/Transwiki guide"
		},
		"2": {
			"label": "Sort key",
			"type": "string",
			"default": "{{PAGENAME}}",
			"description": "A custom sort key for [[:Category:Transwiki guide]]"
		},
		"small": {
			"label": "Small ombox",
			"type": "boolean",
			"default": "0"
		},
		"text": {
			"label": "Complete text override",
			"type": "content",
			"deprecated": true
		}
	}
}
</templatedata>

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia notification templates]]
}}</includeonly>