Template:Item/doc: Difference between revisions

(7 intermediate revisions by the same user not shown)

Line 6:

==Syntax==

</syntaxhighlight>

This template has 2 unnamed parameters:

* {{F|1}} / {{F|name}} – Name of the item.

* {{F|2}} / {{F|size}} – Size of the icon. Default: {{F|30}}.

* {{F|2}} / {{F|size}} – Size of the icon {{Color|Old|excluding}} the length unit. Default: {{F|30}}.

* {{F|x}} / {{F|count}} – Quantity of the item~~. Part of the text~~.

* {{F|x}} / {{F|count}} – Quantity of the item.

* {{F|type}} – Special keyword to adjust the file's suffix and prefix.

* {{F|link}} – Set another page to be linked.

* {{F|text}} – Display another text instead of the name of the item.

* {{F|~~notext~~}} – Set to {{F|1}} to omit the complete text. ~~The icon will no longer behave like an inline~~-~~block~~.

* {{F|no_text}} – Set to {{F|1}} to omit the complete text.

* {{F|invert}} – Set to apply a filter to the image for either day/light or night/dark mode. Available values:

** Default – See: [[Module:Item/Invert]].

** {{F|Day}} – Invert the image in day/light mode. Will invert light-colored icons to gray in day/light mode.

** {{F|Night}} – Invert the image in night/dark mode. Will invert dark-colored icons to white in night/dark mode.

* {{F|note}} – Append a note after the item text and count.

* {{F|ref}} – Append a reference to the item text.

* {{F|comma}} – Set to {{F|1}} to append a comma to the item text following AmE rules.

* {{F|dot}} – Set to {{F|1}} to append a dot to the item text following AmE rules.

* {{F|~~commaspc~~}} – Set to {{F|1}} to append a comma and a space to the item text following AmE rules.

* {{F|comma_spc}} – Set to {{F|1}} to append a comma and a space to the item text following AmE rules.

* {{F|~~dotspc~~}} – Set to {{F|1}} to append a dot and a space to the item text following AmE rules.

* {{F|dot_spc}} – Set to {{F|1}} to append a dot and a space to the item text following AmE rules.

==Examples==

{{T|~~Item|_Ybr_~~=1}}

{{Example|no_copy=1|<nowiki>{{Item}}</nowiki>}}

{{~~T|Item~~|p1=~~Unknown~~|~~_Ybr_=1}}~~<~~br /~~>

{{Example|no_copy=1|<nowiki>{{Item|Kabuto Beetle}}</nowiki>}}

{{T|Item|~~p1=~~Kabuto Beetle~~|_Ybr_=1~~}}

{{Example|no_copy=1|<nowiki>{{Item|Kabuto Beetle|size=64}}</nowiki>}}

{{T|Item|~~p1=~~Kabuto Beetle|~~p2=40|_Ybr_~~=1}}

{{Example|no_copy=1|<nowiki>{{Item|Kabuto Beetle|link=Insect|text=Custom text}}</nowiki>}}

{{T|Item|~~p1=~~Kabuto Beetle|~~p2=~~link=Insect|~~p3=~~text=Custom text~~|_Ybr_=1~~}}

{{Example|no_copy=1|<nowiki>{{Item|Dough|x=15|no_text=1}}</nowiki>}}

{{T|Item|~~p1=~~Dough|~~p2=~~x=15|~~p3=notext=1|_Ybr_~~=1}}

{{Example|no_copy=1|<nowiki>{{Item|Hexia|note=Galaxy}}</nowiki>}}

{{T|Item|~~p1=Elsasani~~|~~_Ybr_~~=1}}

{{Example|no_copy=1|<nowiki>{{Item|Elsasani|text="Sani"|dot=1}}</nowiki>}}

==Template Data==

Line 52:

Line 55:

],

"label": "Size",

"description": "Size of the icon.",

"description": "Size of the icon excluding the length unit.",

"example": "40",

"example": "20, 40",

"type": "number",

"default": "30"

Line 63:

Line 66:

"label": "Quantity",

"description": "Quantity of the item.",

"example": "1",

"example": "1, 5, 10",

"type": "number"

},

Line 77:

Line 80:

"type": "wiki-page-name",

"default": "<1>, <name>"

},

~~"notext": {~~

~~"label": "No text",~~

~~"description": "Set to 1 to omit the complete text.",~~

~~"example": "1",~~

~~"type": "boolean"~~

},

"note": {

Line 92:

Line 89:

"label": "Reference",

"description": "Append a reference to the item text.",

"type": "~~unbalanced-wikitext~~"

"type": "string"

},

"comma": {

Line 106:

Line 103:

"type": "boolean"

},

"~~commaspc~~": {

"comma_spc": {

"label": "Comma and space",

"description": "Set to 1 to append a comma and a space to the item text following AmE rules.",

Line 112:

Line 109:

"type": "boolean"

},

"~~dotspc~~": {

"dot_spc": {

"label": "Dot and space",

"description": "Set to 1 to append a dot and a space to the item text following AmE rules.",

"example": "1",

"type": "boolean"

},

"no_text": {

"label": "No text",

"description": "Set to 1 to omit the complete text.",

"example": "1",

"type": "boolean"

},

"invert": {

"label": "Invert",

"description": "Set to apply a filter to the image for either day/light or night/dark mode.",

"example": "Day, Night",

"type": "string"

}

},

"description": "Template that adds a link to icons.",

"format": "inline"

"format": "inline",

"paramOrder": [

"1",

"2",

"x",

"type",

"link",

"no_text",

"invert",

"note",

"ref",

"comma",

"dot",

"comma_spc",

"dot_spc"

]

}

</templatedata>

@@ Line 6: / Line 6: @@
 ==Syntax==
 <syntaxhighlight lang="wikitext" copy>
-{{Item|}}
+{{Item}}
 </syntaxhighlight>
 This template has 2 unnamed parameters:
 * {{F|1}} / {{F|name}} &ndash; Name of the item.
-* {{F|2}} / {{F|size}} &ndash; Size of the icon. Default: {{F|30}}.
+* {{F|2}} / {{F|size}} &ndash; Size of the icon {{Color|Old|excluding}} the length unit. Default: {{F|30}}.
-* {{F|x}} / {{F|count}} &ndash; Quantity of the item. Part of the text.
+* {{F|x}} / {{F|count}} &ndash; Quantity of the item.
 * {{F|type}} &ndash; Special keyword to adjust the file's suffix and prefix.
 * {{F|link}} &ndash; Set another page to be linked.
 * {{F|text}} &ndash; Display another text instead of the name of the item.
-* {{F|notext}} &ndash; Set to {{F|1}} to omit the complete text. The icon will no longer behave like an inline-block.
+* {{F|no_text}} &ndash; Set to {{F|1}} to omit the complete text.
+* {{F|invert}} &ndash; Set to apply a filter to the image for either day/light or night/dark mode. Available values:
+** Default &ndash; See: [[Module:Item/Invert]].
+** {{F|Day}} &ndash; Invert the image in day/light mode. Will invert light-colored icons to gray in day/light mode.
+** {{F|Night}} &ndash; Invert the image in night/dark mode. Will invert dark-colored icons to white in night/dark mode.
 * {{F|note}} &ndash; Append a note after the item text and count.
 * {{F|ref}} &ndash; Append a reference to the item text.
 * {{F|comma}} &ndash; Set to {{F|1}} to append a comma to the item text following AmE rules.
 * {{F|dot}} &ndash; Set to {{F|1}} to append a dot to the item text following AmE rules.
-* {{F|commaspc}} &ndash; Set to {{F|1}} to append a comma and a space to the item text following AmE rules.
+* {{F|comma_spc}} &ndash; Set to {{F|1}} to append a comma and a space to the item text following AmE rules.
-* {{F|dotspc}} &ndash; Set to {{F|1}} to append a dot and a space to the item text following AmE rules.
+* {{F|dot_spc}} &ndash; Set to {{F|1}} to append a dot and a space to the item text following AmE rules.
 ==Examples==
-{{T|Item|_Ybr_=1}}<br />
+{{Example|no_copy=1|<nowiki>{{Item}}</nowiki>}}
-{{T|Item|p1=Unknown|_Ybr_=1}}<br />
+{{Example|no_copy=1|<nowiki>{{Item|Kabuto Beetle}}</nowiki>}}
-{{T|Item|p1=Kabuto Beetle|_Ybr_=1}}<br />
+{{Example|no_copy=1|<nowiki>{{Item|Kabuto Beetle|size=64}}</nowiki>}}
-{{T|Item|p1=Kabuto Beetle|p2=40|_Ybr_=1}}<br />
+{{Example|no_copy=1|<nowiki>{{Item|Kabuto Beetle|link=Insect|text=Custom text}}</nowiki>}}
-{{T|Item|p1=Kabuto Beetle|p2=link=Insect|p3=text=Custom text|_Ybr_=1}}<br />
+{{Example|no_copy=1|<nowiki>{{Item|Dough|x=15|no_text=1}}</nowiki>}}
-{{T|Item|p1=Dough|p2=x=15|p3=notext=1|_Ybr_=1}}<br />
+{{Example|no_copy=1|<nowiki>{{Item|Hexia|note=Galaxy}}</nowiki>}}
-{{T|Item|p1=Elsasani|_Ybr_=1}}<br />
+{{Example|no_copy=1|<nowiki>{{Item|Elsasani|text="Sani"|dot=1}}</nowiki>}}
-{{T|Item|p1=Hexia|p2=note=Galaxy|_Ybr_=1}}
 ==Template Data==
@@ Line 52: / Line 55: @@
 			],
 			"label": "Size",
-			"description": "Size of the icon.",
+			"description": "Size of the icon excluding the length unit.",
-			"example": "40",
+			"example": "20, 40",
 			"type": "number",
 			"default": "30"
@@ Line 63: / Line 66: @@
 			"label": "Quantity",
 			"description": "Quantity of the item.",
-			"example": "1",
+			"example": "1, 5, 10",
 			"type": "number"
 		},
@@ Line 77: / Line 80: @@
 			"type": "wiki-page-name",
 			"default": "<1>, <name>"
-		},
-		"notext": {
-			"label": "No text",
-			"description": "Set to 1 to omit the complete text.",
-			"example": "1",
-			"type": "boolean"
 		},
 		"note": {
@@ Line 92: / Line 89: @@
 			"label": "Reference",
 			"description": "Append a reference to the item text.",
-			"type": "unbalanced-wikitext"
+			"type": "string"
 		},
 		"comma": {
@@ Line 106: / Line 103: @@
 			"type": "boolean"
 		},
-		"commaspc": {
+		"comma_spc": {
 			"label": "Comma and space",
 			"description": "Set to 1 to append a comma and a space to the item text following AmE rules.",
@@ Line 112: / Line 109: @@
 			"type": "boolean"
 		},
-		"dotspc": {
+		"dot_spc": {
 			"label": "Dot and space",
 			"description": "Set to 1 to append a dot and a space to the item text following AmE rules.",
 			"example": "1",
 			"type": "boolean"
+		},
+		"no_text": {
+			"label": "No text",
+			"description": "Set to 1 to omit the complete text.",
+			"example": "1",
+			"type": "boolean"
+		},
+		"invert": {
+			"label": "Invert",
+			"description": "Set to apply a filter to the image for either day/light or night/dark mode.",
+			"example": "Day, Night",
+			"type": "string"
 		}
 	},
 	"description": "Template that adds a link to icons.",
-	"format": "inline"
+	"format": "inline",
+	"paramOrder": [
+		"1",
+		"2",
+		"x",
+		"type",
+		"link",
+		"no_text",
+		"invert",
+		"note",
+		"ref",
+		"comma",
+		"dot",
+		"comma_spc",
+		"dot_spc"
+	]
 }
 </templatedata>

Template:Item/doc: Difference between revisions

Stevium (talk | contribs)