Jump to content

Template:Note/Doc: Difference between revisions

From Official NixOS Wiki
DoggoBit (talk | contribs)
No edit summary
DoggoBit (talk | contribs)
Hide templatedata from doc page, make note message required
 
(One intermediate revision by the same user not shown)
Line 14: Line 14:


{{note|leading=For your information.|This information is important and highlighted to you.}}
{{note|leading=For your information.|This information is important and highlighted to you.}}
<includeonly>
=== 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",
      "required": true
    },
    "leading": {
      "label": "Leading text",
      "description": "If set, this will replace the 'Note:' text at the beginning of the note",
      "type": "string"
    }
  }
}
</templatedata>
</includeonly>

Latest revision as of 14:15, 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.

Usage

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.