View source for Template:Uses TemplateStyles/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page -->
{{Lua|Module:Uses TemplateStyles}}

This template is used to show that templates have been converted to use [[mw:Special:MyLanguage/Help:TemplateStyles|TemplateStyles]]. It is placed at the top of the template's /doc page. It automatically adds the template to [[:Category:Templates using TemplateStyles]], or to one of its subcategories.

== Usage ==

; Basic : {{tld|Uses TemplateStyles|''TemplateStyles page name''}}

; All parameters : {{tld|Uses TemplateStyles|''TemplateStyles page 1''|''TemplateStyles page 2''|''TemplateStyles page 3''|...|category{{=}}''custom category''|nocat{{=}}''true''}}

The first TemplateStyles page name is required.

=== TemplateStyles sandboxes ===
Note that if a sandbox version of the TemplateStyle exists, it will also be linked. This is only for sandbox versions. The subpage name of the sandbox version should be the same, but as a subpage of the templates sandbox. For example, if the TemplateStyles page name is <code>Template:Foo/styles.css</code>, then the sandbox version should be <code>Template:Foo/sandbox/styles.css</code>

== Examples ==
=== One style page ===
{{tld|Uses TemplateStyles|Template:Arrowlist/styles.css}}
{{Uses TemplateStyles|Template:Arrowlist/styles.css|nocat=true}}
{{clear}}

=== Multiple style pages ===
{{tld|Uses TemplateStyles|Template:Arrowlist/styles.css|Template:Routemap/styles.css}}
{{Uses TemplateStyles|Template:Arrowlist/styles.css|Template:Routemap/styles.css|nocat=true}}
{{clear}}

=== Sandbox version of style page exists ===
{{tld|Uses TemplateStyles|Template:Uses TemplateStyles/example.css}}
{{Uses TemplateStyles|Template:Uses TemplateStyles/example.css|nocat=true}}
{{clear}}

=== No style pages specified ===
{{tld|Uses TemplateStyles}}
{{Uses TemplateStyles|nocat=true}}
{{clear}}

== Categories ==
=== Template category ===
This template adds pages to [[:Category:Templates using TemplateStyles]] if the page is in the template namespace, and it is not on any of the subpages /doc, /sandbox, /sandbox2 or /testcases. You can specify a different category with the {{para|category}} parameter, e.g. {{para|category|Uses list TemplateStyles}}.

=== Error category ===
If no modules are specified, the transcluded page will be added to {{Red link|Category:Uses TemplateStyles templates with errors}}.

=== Protection level category ===
TemplateStyles should have the same protection level as the template they are used on. If a difference is detected, the transcluded page will be added to [[:Category:Templates using TemplateStyles with a different protection level]].

=== Category suppression ===
To suppress all categories, use {{para|nocat|true}}. (As well as "true", the values "yes", "y", and "1" will also work.)

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"description": "Used to show that templates have been converted to use TemplateStyles.",
	"format": "inline",
	"params": {
		"1": {
			"label": "Stylesheet 1",
			"description": "Name of the main stylesheet used in the template or module. Use multiple parameters to specify multiple stylesheets.",
			"required": true,
			"type": "wiki-page-name"
		},
		"2": {
			"label": "Stylesheet 2",
			"description": "Name of the second stylesheet.",
			"type": "wiki-page-name"
		},
		"3": {
			"label": "Stylesheet 3",
			"description": "Name of the third stylesheet.",
			"type": "wiki-page-name"
		},
		"4": {
			"label": "Stylesheet 4",
			"description": "Name of the fourth stylesheet.",
			"type": "wiki-page-name"
		},
		"5": {
			"label": "Stylesheet 5",
			"description": "Name of the fifth stylesheet.",
			"type": "wiki-page-name"
		},
		"6": {
			"label": "Stylesheet 6",
			"description": "Name of the sixth stylesheet.",
			"type": "wiki-page-name"
		},
		"7": {
			"label": "Stylesheet 7",
			"description": "Name of the seventh stylesheet.",
			"type": "wiki-page-name"
		},
		"8": {
			"label": "Stylesheet 8",
			"description": "Name of the eighth stylesheet.",
			"type": "wiki-page-name"
		},
		"9": {
			"label": "Stylesheet 9",
			"description": "Name of the ninth stylesheet.",
			"type": "wiki-page-name"
		},
		"10": {
			"label": "Stylesheet 10",
			"description": "Name of the tenth stylesheet.",
			"type": "wiki-page-name"
		},
		"nocat": {
			"label": "No Category?",
			"description": "Whether to disable categorization.",
			"default": "0",
			"autovalue": "1",
			"type": "boolean"
		},
		"noprotcat": {
			"label": "No Protection Category?",
			"description": "Whether to disable checking that the stylesheet page(s) have same protection level as the template.",
			"default": "0",
			"autovalue": "1",
			"type": "boolean"
		},
		"category": {
			"label": "Custom Category",
			"description": "Main category to put on pages using this template, without namespace prefix.",
			"default": "Templates using TemplateStyles",
			"type": "string"
		}
	}
}
</templatedata>

== See also ==
* {{tld|Lua}}
<includeonly>{{Sandbox other||
<!-- Categories below this line -->
[[Category:Template documentation]]
[[Category:Templates using TemplateStyles| ]]
}}</includeonly>