Template:Note/Doc: Difference between revisions

Revision as of 14:13, 11 June 2025

This template can be used for displaying important information that shouldn't disrupt the normal reading flow.

Note: This information is important and highlighted to you.

You can simply include this template, along with a message to be displayed:

{{note|This information is important and highlighted to you.}}

You can also change the leading text (the "Note" part):

{{note|leading=For your information.|This information is important and highlighted to you.}}

For your information. This information is important and highlighted to you.

Display an important message without disrupting the normal reading flow

Template parameters
Parameter		Description	Type	Status
Note content	`1`	The message to be included in the note	String	optional
Leading text	`leading`	If set, this will replace the 'Note:' text at the beginning of the note	String	optional

@@ Line 14: / Line 14: @@
 {{note|leading=For your information.|This information is important and highlighted to you.}}
+=== Template data ===
+<templatedata>
+{
+  "description": "Display an important message without disrupting the normal reading flow",
+  "params": {
+    "1": {
+      "label": "Note content",
+      "description": "The message to be included in the note",
+      "type": "string"
+    },
+    "leading": {
+      "label": "Leading text",
+      "description": "If set, this will replace the 'Note:' text at the beginning of the note",
+      "type": "string"
+    }
+  }
+}
+</templatedata>