Template:Transwiki guide/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 03:20, 17 June 2024

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 document page, you should add it inside <includeonly>...</includeonly> tags at the top.

Syntax

Basic

{{transwiki guide}}

All parameters

{{transwiki guide|page|category sort|small=yes}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Transwiki guide in articles based on its TemplateData.

TemplateData for Transwiki guide

No description.

Template parameters
Parameter		Description	Type	Status
Transwiki page override	`1`	no description Default {{FULLPAGENAME}}/Transwiki guide	Page name	optional
Sort key	`2`	A custom sort key for [[:Category:Transwiki guide]] Default {{PAGENAME}}	String	optional
Small ombox	`small`	no description Default 0	Boolean	optional
Complete text override	`text`	no description	Content	deprecated

@@ Line 14: / Line 14: @@
  &#123;&#123;transwiki guide&#124;''page''&#124;''category sort''&#124;small=''yes''&#125;&#125;
-== Parameters ==
+== TemplateData ==
+{{TemplateData header}}
+<templatedata>
-* <code>1</code> - a custom transwiki page. The default is <nowiki>[[{{FULLPAGENAME}}/Transwiki guide]]</nowiki>.
+{
-* <code>2</code> - a custom sort key for [[:Category:Transwiki guide]]. The default is <nowiki>{{PAGENAME}}</nowiki>.
+	"params": {
-* <code>small</code> - if this is set to "yes", a small template is output.
+		"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 | |