Template:Notify/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Inline mode: very very very very very very very very very very very very very very very very very very very very very very very very very very very minor grammar)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Doc/subpage}}
{{Doc/subpage}}
Different types of notifications in one template. Created as a basis for other templates.
Different types of notifications in one template. Created as a basis for other templates.
== Usage ==
{{Template usage example|column}}


== Copy and Paste ==
== Copy and Paste ==
Line 90: Line 93:
* {{Code|[[/inline/doc]]}} - Documentation for inline note templates.
* {{Code|[[/inline/doc]]}} - Documentation for inline note templates.


== See Also ==
== See also ==
* [[:Category:Modern Templates]]
* [[:Category:Modern Templates]]
* [[:Category:Inline note templates]]
* [[:Category:Inline note templates]]

Latest revision as of 10:32, 5 October 2025

Edit-copy.png
This is a documentation subpage for Template:Notify.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Different types of notifications in one template. Created as a basis for other templates.

Usage

This template is usually written in a column. To use it, insert {{Notify}} on the desired page and specify the parameters under the template name in the following format:

{{Notify | parameter 1 = value | parameter 2 = value }}

Copy and Paste

{{Notify | mode = inline | size = 10px | img = | text = | color = }}

Parameters and Examples

Shared

Parameter Description Example Preview
{{{1}}} or {{{text}}} Your text.
Icon-Important.pngImportant: Do not use {{{text}}} in other templates that are based on this template. The named parameter breaks the lists.
| Hello, World!
| text = Hello, World!
Hello, World!
Hello, World!
{{{mode}}} Switches the template modes. Avaliable modes: inline.
| mode = inline
Hello, World!

Inline mode

Parameter Description Example Preview
{{{img}}} Notification icon.
| img = Note.png
Hello, World!
{{{size}}} Notification icon size (Highly recommended to specify since most icons support high DPI.)
| size = 16px
Important template.pngImportant:Hello, World!
{{{type}}} Notification type.
| type = Warning
Important template.pngImportant:Hello, World!
{{{color}}} Notification color (RGB only).
RGBA may also work.
| color = 240,211,0
Important template.pngImportant:Hello, World!

Offset

  1. Important template.pngImportant:Hello, World!
  2. Important template.pngImportant:Hello, World!
  3. Important template.pngImportant:Hello, World!
  4. Important template.pngImportant:Hello, World!
  5. Important template.pngImportant:Hello, World!
  6. Important template.pngImportant:Hello, World!
  7. Important template.pngImportant:Hello, World!

Custom styles

  1. Important template.pngImportant:Hello, World!
  2. Important template.pngImportant:Hello, World!
  3. Important template.pngImportant:Hello, World!
  4. Important template.pngImportant:Hello, World!
  5. Important template.pngImportant:Hello, World!
  6. Important template.pngImportant:Hello, World!
  7. Important template.pngImportant:Hello, World!
  8. Important template.pngImportant:Hello, World!
  9. Important template.pngImportant:Hello, World!
  10. Important template.pngImportant:Hello, World!
  11. Important template.pngImportant:Hello, World!
  12. Important template.pngImportant:Hello, World!
  13. Important template.pngImportant:Hello, World!
  14. Important template.pngImportant:Hello, World!
  15. Important template.pngImportant:Hello, World!
  16. Important template.pngImportant:Hello, World!

Special Subpages

See also