SockyPaws: Create template documentation

2024-11-23T00:27:27Z

Create template documentation

New page

{{Documentation subpage}}
The {{Template link general|plaincode=on|X-mark}} template inserts an inline image of an ''"X"''. It is often used as the opposite of {{Template link general|plaincode=on|Tick}}.

== Usage ==
This template inserts a diagonal/saltire cross (''"X"'') image inline with the surrounding text, with several choices of coloring. This is meant to semiotically indicate negation or some other negative message, such as rejection, failure, falsehood, etc.

=== Size ===
The cross image defaults to 22px in height; to change the size, include a numeric pixel value as an unnamed/positional argument, such as:
: {{Template link general|italic=on|nolink=on|plaincode=on|X-mark|'''36'''}} ⇒ {{X-mark|36}}

=== Color ===
The {{Para|color}} (or {{Para|colour}}) parameter can be used to change the image's color:

{| class="wikitable" style="min-width: 40vw; text-align: center;"
! scope="col" colspan="4" | Color codes
! scope="col" | Output
! scope="col" | Notes
|-
| {{Code|red}}
| colspan="2" | {{Code|rd}}
| {{Code|r}}
| [[File:Red X mark 3D.png|x22px]]
| Default appearance
|-
| {{Code|darkred}}
| {{Code|dkred}}
| {{Code|drd}}
| {{Code|dr}}
| [[File:Dark Red x.svg|x22px]] ||
|-
| {{Code|orange}}
| {{Code|orng}}
| {{Code|or}}
| {{Code|o}}
| [[File:Orange X mark gradient.png|x22px]] ||
|-
| {{Code|yellow}}
| {{Code|yel}}
| {{Code|ylw}}
| {{Code|y}}
| [[File:Dark yellow X mark.png|x22px]] ||
|-
| {{Code|green}}
| colspan="2" | {{Code|grn}}
| {{Code|gn}}
| [[File:Green X mark.png|x22px]] ||
|-
| {{Code|blue}}
| colspan="2" | {{Code|blu}}
| {{Code|bl}}
| [[File:Blue X mark.png|x22px]] ||
|-
| {{Code|indigo}}
| colspan="2" | {{Code|ind}}
| {{Code|i}}
| [[File:Indigo X mark.png|x22px]] ||
|-
| {{Code|purple}}
|| {{Code|prpl}}
| {{Code|pur}}
| {{Code|pr}}
| [[File:Purple X mark.png|x22px]] ||
|-
| {{Code|gray}}
| {{Code|grey}}
| {{Code|gry}}
| {{Code|gy}}
| [[File:Gray X mark.png|x22px]] ||
|-
| {{Code|black}}
| {{Code|blk}}
| {{Code|bk}}
| {{Code|k}}
| [[File:Black x.svg|x22px]] ||
|}

== TemplateData ==
<div class="templatedata-header">This is the [[mediawikiwiki:Special:MyLanguage/Help:TemplateData|TemplateData]] for this template used by [[mediawikiwiki:Special:MyLanguage/Help:Extension:TemplateWizard|TemplateWizard]], [[mediawikiwiki:Special:MyLanguage/Help:VisualEditor/User guide|VisualEditor]] and other tools.

'''TemplateData for {{BASEPAGENAME}}'''
<templatedata>{
"description": "Inserts a colored diagonal cross mark image ('X') inline with the surrounding text",
"format": "inline",
"paramOrder": [
"1",
"color"
],
"params": {
"1": {
"label": "Image size",
"description": "Defines the height of the image in pixels; do not include a 'px' unit suffix.",
"type": "number",
"default": "22",
"required": false,
"example": "36",
"suggestedvalues": [
"16",
"20",
"24",
"32",
"36",
"48",
"64",
"72",
"96",
"128"
]
},
"color": {
"aliases": [
"colour"
],
"label": "Mark color",
"description": "Defines the color of the X mark image from among a list of common primary, secondary and monochromes values",
"type": "line",
"default": "red",
"required": false,
"example": "green",
"suggestedvalues": [
"red",
"rd",
"r",
"darkred",
"dkred",
"drd",
"dr",
"orange",
"orng",
"or",
"o",
"yellow",
"yel",
"ylw",
"y",
"green",
"grn",
"gn",
"blue",
"blu",
"bl",
"indigo",
"ind",
"i",
"purple",
"prpl",
"pur",
"pr",
"gray",
"grey",
"gry",
"gy",
"black",
"blk",
"bk",
"k"
]
}
}
}</templatedata>

== See also ==
* {{Tl|T}}

=== Check and cross mark templates ===
{{Check mark templates}}

{{Done/See also}}
<includeonly>{{Sandbox other||

[[Category:Icon templates]]
[[Category:Templates with TemplateData]]
[[Category:Voting templates]]
}}</includeonly>

Template:X-mark/doc - Revision history

SockyPaws: Create template documentation