TemplateStyles

Latest revision as of 13:27, 4 December 2023

TemplateStyles notice

This template is used to show that templates use TemplateStyles. It is meant to be placed at the top of the template's documentation and show which CSS styelsheet page(s) it uses. It and automatically adds the template to Category:Templates using TemplateStyles.

This concept is based on Wikipedia's {{Uses TemplateStyles}} template, but is implemented differently. (Using a combination of the {{Sidebar}} and {{Notice}} templates.)

Example(s)

No parameters

When no parameters are set, the template will use "Template:{{PAGENAME}}/styles.css" as the CSS page shown. ({{PAGENAME}} being the name of the actual template.) This should be enough in most cases.

{{TemplateStyles}} generates:

Single parameter

The name of the CSS page to show can be set using the template's first (unnamed) parameter. This is useful if the stylesheet page is not called "styles.css". The whole title must be set except for the "Template:" namespace name.

{{TemplateStyles|TemplateStyles/dark.css}} generates:

Two parameters

A second parameter is available to set any further stylesheets in the case of templates using more then one. This parameter is completely free-form, requiring entering everything manually including the link itself and commas. (An example can be seen bellow)

{{TemplateStyles|TemplateStyles/styles.css|, [[Template:TemplateStyles/dark.css|TemplateStyles/dark.css]] and [[Template:TemplateStyles/dark.css|TemplateStyles/mobile.css]]}}

generates:

Template data

Used to show that a template uses TemplateStyles, and link the CSS page(s) used.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
CSS stylesheet	`1`	The full name of the CSS stylesheet this template uses, excluding the "Template:" namespace name at the start. This parameter is optional. Example Pagetabs/styles.css	Page name	suggested
Further CSS Stylesheets	`2`	Completely free-form parameter for specifying further CSS stylesheets for templates using more then one. Example , [[Template:Pagetabs/dark.css]] and [[Template:Pagetabs/mobile.css]]	String	suggested

@@ Line 1: / Line 1: @@
-{{Sidebar
+<includeonly>{{Sidebar
 |content1={{Notice
 |icon=fa-solid fa-file-code
@@ Line 8: / Line 8: @@
 |title=This template uses TemplateStyles
 |message=<br />
-* [[Template:{{{1|{{PAGENAME}}/styles.css}}}]]{{#if:{{{2|}}}|{{{2}}}}}
+* {{#if:{{{freeform|}}}|{{{freeform}}}|[[{{NAMESPACE}}:{{{1|{{ROOTPAGENAME}}/styles.css}}}]]{{#if:{{{2|}}}|{{{2}}}}}}}
 }}
 |contentstyle=padding:0;
-|bodystyle=padding:0;border-spacing:0;width:auto;background-color:#e9edef;
+|bodystyle=padding:0;border-spacing:0;width:auto;max-width:22em;background-color:#e9edef;
 |navbar=none
-}}[[Category:Templates using TemplateStyles]]<noinclude>
+}}[[Category:Templates using TemplateStyles]]</includeonly><noinclude>
+==TemplateStyles notice==
+This template is used to show that templates use [[mw:Extension:TemplateStyles|TemplateStyles]]. It is meant to be placed at the top of the template's documentation and show which CSS styelsheet page(s) it uses. It and automatically adds the template to [[:Category:Templates using TemplateStyles]].
-{{TemplateStyles|TemplateStyles/styles.css|, [[Template:Lbox/styles.css]], [[Template:Pagetabs/styles.css]]}}
+This concept is based on Wikipedia's {{tt|Uses TemplateStyles|interwiki=wp}} template, but is implemented differently. (Using a combination of the {{tt|Sidebar}} and {{tt|Notice}} templates.)
+===Example(s)===
+====No parameters====
+''When no parameters are set, the template will use "Template:<nowiki>{{PAGENAME}}</nowiki>/styles.css" as the CSS page shown. (<nowiki>{{PAGENAME}}</nowiki> being the name of the actual template.) This should be enough in most cases.''
+{{TemplateStyles}}
+* <code><nowiki>{{TemplateStyles}}</nowiki></code> generates:
+<br />{{clear}}
+====Single parameter====
+''The name of the CSS page to show can be set using the template's first (unnamed) parameter. This is useful if the stylesheet page is not called "styles.css". The whole title must be set except for the "Template:" namespace name.''
+{{TemplateStyles|TemplateStyles/dark.css}}
+* <code><nowiki>{{TemplateStyles|TemplateStyles/dark.css}}</nowiki></code> generates:
+<br />{{clear}}
+====Two parameters====
+''A second parameter is available to set any further stylesheets in the case of templates using more then one. This parameter is completely free-form, requiring entering everything manually including the link itself and commas. (An example can be seen bellow)''
+{{TemplateStyles||, [[Template:TemplateStyles/dark.css|TemplateStyles/dark.css]] and [[Template:TemplateStyles/dark.css|TemplateStyles/mobile.css]]}}
+* <pre style="white-space:pre-line;"><nowiki>{{TemplateStyles|TemplateStyles/styles.css|, [[Template:TemplateStyles/dark.css|TemplateStyles/dark.css]] and [[Template:TemplateStyles/dark.css|TemplateStyles/mobile.css]]}}</nowiki></pre> generates:
+<br />{{clear}}
+===Template data===
+<templatedata>
+{
+	"params": {
+		"1": {
+			"label": "CSS stylesheet",
+			"description": "The full name of the CSS stylesheet this template uses, excluding the \"Template:\" namespace name at the start. This parameter is optional.",
+			"example": "Pagetabs/styles.css",
+			"type": "wiki-page-name",
+			"suggested": true
+		},
+		"2": {
+			"label": "Further CSS Stylesheets",
+			"description": "Completely free-form parameter for specifying further CSS stylesheets for templates using more then one. ",
+			"example": ", [[Template:Pagetabs/dark.css]] and [[Template:Pagetabs/mobile.css]]",
+			"type": "string",
+			"suggested": true
+		}
+	},
+	"format": "inline",
+	"description": "Used to show that a template uses TemplateStyles, and link the CSS page(s) used."
+}
+</templatedata>[[Category:Documentation templates]]
+__NOTOC__
+</noinclude>