Template:Uses TemplateStyles/doc: Difference between revisions
More actions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | |||
{{Template shortcut|TemplateStyles}} | |||
{{Lua{{\sandbox}}|Module:Uses TemplateStyles}} | |||
<!-- Categories go at the bottom of this page, and interwikis go on Wikidata. --> | <!-- Categories go at the bottom of this page, and interwikis go on Wikidata. --> | ||
This template is used to show that templates have been converted to use | '''Preview:''' | ||
This template is used to show that templates have been converted to use [[WP:TemplateStyles|TemplateStyles]]. It is placed at the top of the template's /doc page. It automatically adds the template to [[:Category:{{#invoke:Data|Module:Uses TemplateStyles/config|default_category}}]], or to one of its subcategories. | |||
The syntax for ''actually'' doing a TemplateStyles is, of course: <syntaxhighlight lang="wikitext" inline><templatestyles src="" /></syntaxhighlight> (with the page name in the quotation marks). | |||
== Usage == | == Usage == | ||
; Basic : {{ | ; Basic : <syntaxhighlight lang="wikitext" inline>{{Uses TemplateStyles|TemplateStyles page name}}</syntaxhighlight> | ||
; All parameters : {{ | ; All parameters : <syntaxhighlight lang="wikitext" inline>{{Uses TemplateStyles|TemplateStyles page 1|TemplateStyles page 2|TemplateStyles page 3|...|category=custom category|nocat=true}}</syntaxhighlight> | ||
The first TemplateStyles page name is required. | The first TemplateStyles page name is required. | ||
=== TemplateStyles sandboxes === | ===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> | 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 == | == Examples == | ||
=== One style page === | ===One style page=== | ||
{{ | <syntaxhighlight lang="wikitext" inline>{{Uses TemplateStyles|Template:Arrowlist/styles.css}}</syntaxhighlight> | ||
{{Uses TemplateStyles{{\sandbox}}|Template:Arrowlist/styles.css|nocat=true}} | {{Uses TemplateStyles{{\sandbox}}|Template:Arrowlist/styles.css|nocat=true}} | ||
{{clear}} | {{clear}} | ||
===Multiple style pages=== | |||
=== Multiple style pages === | <syntaxhighlight lang="wikitext" inline>{{Uses TemplateStyles|Template:Arrowlist/styles.css|Template:Routemap/styles.css}}</syntaxhighlight> | ||
{{ | |||
{{Uses TemplateStyles{{\sandbox}}|Template:Arrowlist/styles.css|Template:Routemap/styles.css|nocat=true}} | {{Uses TemplateStyles{{\sandbox}}|Template:Arrowlist/styles.css|Template:Routemap/styles.css|nocat=true}} | ||
{{clear}} | {{clear}} | ||
===Sandbox version of style page exists=== | |||
=== Sandbox version of style page exists === | <syntaxhighlight lang="wikitext" inline>{{Uses TemplateStyles|Template:Uses TemplateStyles/example.css}}</syntaxhighlight> | ||
{{ | |||
{{Uses TemplateStyles{{\sandbox}}|Template:Uses TemplateStyles/example.css|nocat=true}} | {{Uses TemplateStyles{{\sandbox}}|Template:Uses TemplateStyles/example.css|nocat=true}} | ||
{{clear}} | {{clear}} | ||
===No style pages specified=== | |||
=== No style pages specified === | <syntaxhighlight lang="wikitext" inline>{{Uses TemplateStyles}}</syntaxhighlight> | ||
{{ | |||
{{Uses TemplateStyles{{\sandbox}}|nocat=true}} | {{Uses TemplateStyles{{\sandbox}}|nocat=true}} | ||
{{clear}} | {{clear}} | ||
== Categories == | == Categories == | ||
=== Template category === | ===Template category=== | ||
This template adds pages to [[:Category:{{#invoke:Data|Module:Uses TemplateStyles/config|default_category}}]] 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}}. | This template adds pages to [[:Category:{{#invoke:Data|Module:Uses TemplateStyles/config|default_category}}]] 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 === | ===Error category=== | ||
If no modules are specified, the transcluded page will be added to [[:Category:{{#invoke:Data|Module:Uses TemplateStyles/config|error_category}}]]. | If no modules are specified, the transcluded page will be added to [[:Category:{{#invoke:Data|Module:Uses TemplateStyles/config|error_category}}]]. | ||
=== Protection level category === | ===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:{{#invoke:Data|Module:Uses TemplateStyles/config|protection_conflict_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:{{#invoke:Data|Module:Uses TemplateStyles/config|protection_conflict_category}}]]. | ||
=== Category suppression === | === Category suppression === | ||
To suppress all categories, use {{para|nocat|true}}. (As well as "true", the values "yes", "y", and "1" will also work.) | To suppress all categories, use {{para|nocat|true}}. (As well as "true", the values "yes", "y", and "1" will also work.) | ||
Line 54: | Line 57: | ||
== See also == | == See also == | ||
* [[Wikipedia:TemplateStyles]] | |||
* {{tl|Lua}} | * {{tl|Lua}} | ||
<includeonly>{{Sandbox other|| | * {{tl|Uses Wikidata}} | ||
<!-- Categories | <includeonly>{{Sandbox other|| <!-- Categories go here, and interwikis go on Wikidata. --> | ||
[[Category:Template namespace templates]] | |||
[[Category: | |||
}}</includeonly> | }}</includeonly> |
Latest revision as of 23:13, 15 February 2025
This is a documentation subpage for Template:Uses TemplateStyles. It may contain usage information, categories and other content that is not part of the original template page. |
Uses Lua: |
Preview:
This template is used to show that templates have been converted to use 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.
The syntax for actually doing a TemplateStyles is, of course: <templatestyles src="" />
(with the page name in the quotation marks).
Usage
- Basic
{{Uses TemplateStyles|TemplateStyles page name}}
- All parameters
{{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 Template:Foo/styles.css
, then the sandbox version should be Template:Foo/sandbox/styles.css
Examples
One style page
{{Uses TemplateStyles|Template:Arrowlist/styles.css}}
This template uses TemplateStyles: |
Multiple style pages
{{Uses TemplateStyles|Template:Arrowlist/styles.css|Template:Routemap/styles.css}}
This template uses TemplateStyles: |
Sandbox version of style page exists
{{Uses TemplateStyles|Template:Uses TemplateStyles/example.css}}
This template uses TemplateStyles: |
No style pages specified
{{Uses TemplateStyles}}
This template uses TemplateStyles: |
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 |category=
parameter, e.g. |category=Uses list TemplateStyles
.
Error category
If no modules are specified, the transcluded page will be added to 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 |nocat=true
. (As well as "true", the values "yes", "y", and "1" will also work.)
TemplateData
TemplateData for Uses TemplateStyles
Used to show that templates have been converted to use TemplateStyles.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Stylesheet 1 | 1 | Name of the main stylesheet used in the template or module. Use multiple parameters to specify multiple stylesheets. | Page name | required |
Stylesheet 2 | 2 | Name of the second stylesheet. | Page name | optional |
Stylesheet 3 | 3 | Name of the third stylesheet. | Page name | optional |
Stylesheet 4 | 4 | Name of the fourth stylesheet. | Page name | optional |
Stylesheet 5 | 5 | Name of the fifth stylesheet. | Page name | optional |
Stylesheet 6 | 6 | Name of the sixth stylesheet. | Page name | optional |
Stylesheet 7 | 7 | Name of the seventh stylesheet. | Page name | optional |
Stylesheet 8 | 8 | Name of the eighth stylesheet. | Page name | optional |
Stylesheet 9 | 9 | Name of the ninth stylesheet. | Page name | optional |
Stylesheet 10 | 10 | Name of the tenth stylesheet. | Page name | optional |
No Category? | nocat | Whether to disable categorization.
| Boolean | optional |
No Protection Category? | noprotcat | Whether to disable checking that the stylesheet page(s) have same protection level as the template.
| Boolean | optional |
Custom Category | category | Main category to put on pages using this template, without namespace prefix.
| String | optional |
Edit parameter translations
See also
- Wikipedia:TemplateStyles
- {{Lua}}
- {{Uses Wikidata}}