Notice

Latest revision as of 11:03, 4 December 2023

Notice template

This is a template for creating a general notice banner on pages. Useful for communicating some extra information the reader should be aware of.

Use https://fontawesome.com/v6/icons for picking icons, or set an image as one.

See Category:Notice templates for other templates based on this one.

Example(s)

{{Notice
|title=Title of notice
|message=Message Body
|contentbackcolor=
|iconbackcolor=
|icon=
|customiconpadding=
|customcontentpadding=
}}

generates:

Title of notice: Message Body

Template data

A template for leaving a notice banner on articles.

Template parameters
Parameter		Description	Type	Status
Title	`title`	Title of the notice	String	suggested
Message	`message` `content`	The message body of the notice	String	required
Icon	`icon`	FontAwesome icon to display on the notice Example fas fa-edit Auto value `fas fa-edit`	String	optional
Icon color	`iconbackcolor`	Background color of the icon section of the notice	String	optional
Content background color	`contentbackcolor`	Background color of the body of the notice.	String	optional
Icon padding values	`customiconpadding`	Custom padding values for the icon section of the notice Example 10px 10px 10px 10px	String	optional
Content padding values	`customcontentpadding`	Custom padding values for the body of the notice Example 10px 10px 10px 10px	String	optional
Class	`class`	Optional extra CSS classes for the notice	String	optional
Image	`image`	Optional free-form image input in place of the icon, for use in license templates.	String	optional
Border color	`bordercolor`	no description Default #d9d6d3	String	optional
Icon color	`iconcolor`	no description Default white	String	optional
License information	`license`	Machine readable license information (hidden from viewer)	String	optional
clear	`clear`	no description Default left Example left, right, both	String	optional

@@ Line 1: / Line 1: @@
-{{Mbox
+<includeonly><div style="display:flex; margin:10px; float:left; border:1px solid {{{bordercolor|#d9d6d3}}}" class="notice phonefullscreen noexcerpt {{{class|}}}"><!--
-| name       = Notice
+--><div style="display:flex; flex-direction:column; justify-content:center; padding:{{{customiconpadding|12px}}}; background-color:{{{iconbackcolor|#8b0024}}};"><!--
-| demospace  = {{{demospace|}}}
+       --->{{#if:{{{image|}}}|{{{image}}}|{{fa|{{{icon|edit}}}|{{{iconstyle|solid}}}|color={{{iconcolor|white}}}|style=font-size:160%;}} }}<!--
-| style      = {{#if:{{{style|}}} |{{#if:{{{small|}}}||width:80%;}} {{{style}}} }}
+--></div><!--
-| subst      = <includeonly>{{subst:substcheck}}</includeonly>
+--><div style="flex-grow:1; background-color:{{{contentbackcolor|#E9EDEF}}}; display:flex; flex-direction:column; justify-content:center;"><div style="padding:{{{customcontentpadding|12px 14px}}};"><!--
-| type       = notice
+      -->{{#if: {{{title|}}}|'''{{{title|}}}'''|}}{{#if: {{{message|}}}|<b>:</b>|}} {{{message|}}}{{{license|}}}<!--
-| image      = {{#if:{{{image|}}} |[[File:{{{image}}}|40px|Notice]]}}
+--></div></div></div><!--
-| small      = {{{small|}}}
+--><div style="clear:{{{clear|left}}};"></div></includeonly><noinclude>
-| smallimage = {{#if:{{{image|}}} |[[File:{{{image}}}|30px|Notice]]}}
-| imageright = {{#if:{{{imageright|}}} |{{{imageright}}} |{{#if:{{{shortcut|{{{shortcut1|}}}}}} |{{Ombox/shortcut|{{{shortcut|{{{shortcut1|}}}}}}|{{{shortcut2|}}}|{{{shortcut3|}}}|{{{shortcut4|}}}|{{{shortcut5|}}}}}}} }}
+==Notice template==
-| textstyle = {{{textstyle|text-align: {{#if:{{{center|}}}|center|{{{align|left}}}}};}}}
+This is a template for creating a general notice banner on pages. Useful for communicating some extra information the reader should be aware of.
-| text       = {{#if:{{{header|{{{heading|{{{title|}}}}}}}}} |<div style="{{{headstyle|text-align: {{#if:{{{center|}}}|center|left}};}}}">'''{{{header|{{{heading|{{{title|}}}}}}}}}'''</div>}}<!--
-            -->{{{text|{{{content|{{{reason|{{{1}}}}}}}}}}}}
+Use [https://fontawesome.com/v6/icons https://fontawesome.com/v6/icons] for picking icons, or set an image as one.
-}}<noinclude>
-{{Documentation}}
+See [[:Category:Notice templates]] for other templates based on this one.
+===Example(s)===
+<pre>{{Notice
+|title=Title of notice
+|message=Message Body
+|contentbackcolor=
+|iconbackcolor=
+|icon=
+|customiconpadding=
+|customcontentpadding=
+}}</pre> generates: {{Notice
+|title=Title of notice
+|message=Message Body
+}}
+==Template data==
+<templatedata>
+{
+	"params": {
+		"iconbackcolor": {
+			"label": "Icon color",
+			"description": "Background color of the icon section of the notice",
+			"type": "string"
+		},
+		"class": {
+			"label": "Class",
+			"description": "Optional extra CSS classes for the notice",
+			"type": "string"
+		},
+		"image": {
+			"label": "Image",
+			"description": "Optional free-form image input in place of the icon, for use in license templates.",
+			"type": "string"
+		},
+		"customiconpadding": {
+			"label": "Icon padding values",
+			"description": "Custom padding values for the icon section of the notice",
+			"example": "10px 10px 10px 10px",
+			"type": "string"
+		},
+		"icon": {
+			"label": "Icon",
+			"description": "FontAwesome icon to display on the notice",
+			"example": "fas fa-edit",
+			"type": "string",
+			"autovalue": "fas fa-edit"
+		},
+		"contentbackcolor": {
+			"label": "Content background color",
+			"description": "Background color of the body of the notice.",
+			"type": "string"
+		},
+		"customcontentpadding": {
+			"label": "Content padding values",
+			"description": "Custom padding values for the body of the notice",
+			"example": "10px 10px 10px 10px",
+			"type": "string"
+		},
+		"title": {
+			"label": "Title",
+			"description": "Title of the notice",
+			"type": "string",
+			"suggested": true
+		},
+		"message": {
+			"aliases": [
+				"content"
+			],
+			"label": "Message",
+			"description": "The message body of the notice",
+			"type": "string",
+			"required": true
+		},
+		"bordercolor": {
+			"label": "Border color",
+			"type": "string",
+			"default": "#d9d6d3"
+		},
+		"iconcolor": {
+			"label": "Icon color",
+			"type": "string",
+			"default": "white"
+		},
+		"license": {
+			"label": "License information",
+			"description": "Machine readable license information (hidden from viewer)",
+			"type": "string"
+		},
+		"clear": {
+			"label": "clear",
+			"example": "left, right, both",
+			"type": "string",
+			"default": "left"
+		}
+	},
+	"paramOrder": [
+		"title",
+		"message",
+		"icon",
+		"iconbackcolor",
+		"contentbackcolor",
+		"customiconpadding",
+		"customcontentpadding",
+		"class",
+		"image",
+		"bordercolor",
+		"iconcolor",
+		"license",
+		"clear"
+	],
+	"description": "A template for leaving a notice banner on articles."
+}
+</templatedata> [[Category:Notice templates]] {{Interface template}}
 </noinclude>