Template:Ink: Difference between revisions

Latest revision as of 11:49, 18 December 2024

Warning: Class template

This is the main template for the Ink class—it should primarily be used with Form:Ink to create or edit associated pages, and not invoked in other circumstances. Most of the content can be edited with the VisualEditor, but for best functionality please use the specified form.

Pages which use this template are listed at Category:Inks.

TemplateData

The main template for the "Ink" class. This template handles semantic annotation and transcludes display templates for the data (mainly Template:Infobox ink).

Template parameters[Edit template data]
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Brand	`brand`	The brand of manufacture (Riso, Ricoh, etc.) for the color of ink. Generic inks may also be listed on this page—but this attribute should reflect the original brand. Suggested values `Riso` `Riso Compatible` `Ricoh`	String	required
Series	`series`	The series name that the ink is part of (for Riso, these are "Standard," "Special Edition," and "Custom"). Suggested values `Standard` `Special Edition` `Custom` `Mixed`	String	suggested
Japanese name	`japanese_name`	The Japanese name for the ink (if available/provided by the manufacturer).	String	optional
RGB	`rgb`	The RGB code for the color—this is used for its display throughout the wiki. It must formatted as a comma-separated list with no spaces: XXX,XXX,XXX Example 172,147,110	String	required
Hex code	`hex`	The hex code for the color (without a pound sign). Example AC936E	String	suggested
CMYK	`cmyk`	The CMYK code for the color. It must formatted as a comma-separated list with no spaces: XX,XX,XX,XX Example 22,33,68,8	String	suggested
CIELab*	`cielab`	The CIELab* code for the color. It must formatted as a comma-separated list with no spaces: XX,XX,XX Example 67,8,20	String	suggested
Pantone	`pantone`	The Pantone swatch code for the color. Example 872 U	String	deprecated
Products	`products`	A list of product codes associated with the ink. These are implemented with Template:Ink/product—please use the page form Form:Ink to edit them.	Content	optional

@@ Line 1: / Line 1: @@
-<includeonly>{{Infobox ink
+<noinclude>{{Class template|class=Ink|category=Inks}}
+== TemplateData ==
+<templatedata>
+{
+	"params": {
+		"japanese_name": {
+			"label": "Japanese name",
+			"description": "The Japanese name for the ink (if available/provided by the manufacturer).",
+			"type": "string"
+		},
+		"brand": {
+			"label": "Brand",
+			"description": "The brand of manufacture (Riso, Ricoh, etc.) for the color of ink. Generic inks may also be listed on this page—but this attribute should reflect the original brand.",
+			"type": "string",
+			"suggestedvalues": [
+				"Riso",
+				"Riso Compatible",
+				"Ricoh"
+			],
+			"required": true
+		},
+		"series": {
+			"label": "Series",
+			"description": "The series name that the ink is part of (for Riso, these are \"Standard,\" \"Special Edition,\" and \"Custom\").",
+			"type": "string",
+			"suggestedvalues": [
+				"Standard",
+				"Special Edition",
+				"Custom",
+				"Mixed"
+			],
+			"suggested": true
+		},
+		"hex": {
+			"label": "Hex code",
+			"description": "The hex code for the color (without a pound sign).",
+			"example": "AC936E",
+			"type": "string",
+			"suggested": true
+		},
+		"rgb": {
+			"label": "RGB",
+			"description": "The RGB code for the color—this is used for its display throughout the wiki. It must formatted as a comma-separated list with no spaces: XXX,XXX,XXX",
+			"example": "172,147,110",
+			"type": "string",
+			"required": true
+		},
+		"cmyk": {
+			"label": "CMYK",
+			"description": "The CMYK code for the color. It must formatted as a comma-separated list with no spaces: XX,XX,XX,XX",
+			"example": "22,33,68,8",
+			"type": "string",
+			"suggested": true
+		},
+		"cielab": {
+			"label": "CIELab*",
+			"description": "The CIELab* code for the color. It must formatted as a comma-separated list with no spaces: XX,XX,XX",
+			"example": "67,8,20",
+			"type": "string",
+			"suggested": true
+		},
+		"pantone": {
+			"label": "Pantone",
+			"description": "The Pantone swatch code for the color.",
+			"example": "872 U",
+			"type": "string",
+			"deprecated": "Pantone is no longer supported by Adobe, so this is less used—but can still be valuable for color matching inks to papers etc."
+		},
+		"products": {
+			"label": "Products",
+			"description": "A list of product codes associated with the ink. These are implemented with Template:Ink/product—please use the page form Form:Ink to edit them.",
+			"type": "content"
+		}
+	},
+	"description": "The main template for the \"Ink\" class. This template handles semantic annotation and transcludes display templates for the data (mainly Template:Infobox ink).",
+	"paramOrder": [
+		"brand",
+		"series",
+		"japanese_name",
+		"rgb",
+		"hex",
+		"cmyk",
+		"cielab",
+		"pantone",
+		"products"
+	],
+	"format": "block"
+}
+</templatedata>
+</noinclude><includeonly>{{Infobox ink
    | title             = {{PAGENAME}}
    | japanese_name     = {{{japanese_name|}}}
@@ Line 10: / Line 100: @@
    | pantone           = {{{pantone|}}}
    | products          = {{{products|}}}
-}}
+}}<!--
-[[Category:Inks]]
+-->[[Category:Inks]]<!--
-</includeonly>
+-->{{#if:{{{brand|}}}|[[Category:{{ucfirst:{{{brand}}}}} inks]]|}}<!--
-<noinclude>
+-->{{#set:
-<!-- {{#template_params:}} -->
-</noinclude>
-{{#set:
      Has Japanese name = {{{japanese_name|}}}
    | Has brand         = {{{brand|}}}
@@ Line 25: / Line 112: @@
    | Has cielab        = {{{cielab|}}}
    | Has pantone       = {{{pantone|}}}
-}}
+}}</includeonly>