Help:Templates: Difference between revisions

Line 24:

* [[Template:cleanup|<nowiki>{{cleanup}}</nowiki>]] for pages that don't follow the [[Project:Manual of Style|Manual of Style]]

=== ~~Note~~ templates ===

=== Notice templates ===

~~These templates~~ are ~~purposefully intrusive~~, and ~~serve as a visual landmark~~ to ~~an important note~~.

In general, there are two kinds of notes you can use: ''big'' and ''small'' notices. '''Small notices''' integrate well within the flow of the text, and are meant to convey information that shouldn't distract too much from the reading flow. The table below shows the main small notes available:

* [[Template~~:tip~~|~~<nowiki>~~{{~~tip~~}}~~</nowiki>]]~~ for ~~a tip~~.

{| class="wikitable" style="width: 100%;"

* [[Template:warning|~~<nowiki>~~{{~~warning~~}}~~</nowiki>]] for a non-security warning.~~

| Template

* [[Template:Security Warning|~~<nowiki>~~{{~~Security Warning~~}}~~</nowiki>]]~~ for ~~a security warning~~.

| Example

| Notes

|-

| {{template link|note}}

| {{note|This is some important information}}

| To be used for important information that shouldn't break the reading flow.

|-

| {{template link|aside}}

| {{aside|This information is not that important.}}

| To be used for related information that is not essential for the main body of an article.

|}

~~These templates~~ should be ~~used sparingly~~, ~~but are useful as they are less intrusive~~.

'''Big notices''' are purposefully disruptive, and are meant to capture a reader's attention. Use these to convey information that should be read first, especially when the user is glancing over a page without reading it in detail.

* [[Template~~:note~~|~~<nowiki>~~{{~~note~~}}~~</nowiki>]]~~ for ~~a note~~.

* [[Template:aside|~~<nowiki>~~{{~~aside~~}}~~</nowiki>]]~~ for ~~an aside comment about a section~~.

{| class="wikitable" style="width: 100%;"

| Template

| Example

| Notes

|-

| {{template link|tip}}

| {{tip|Something you might easily miss}}

| To be used for quick reminders that users often miss.

|-

| {{template link|info}}

| {{info|Some key information you should be aware of}}

| To be used for bringing key information to the reader's attention.

|-

| {{template link|warning}}

| {{warning|This information is highly important.}}

| To be used for marking potentially dangerous, disruptive or destructive actions.

|-

| {{template link|security Warning}}

| {{security Warning|This information is paramount.}}

| To be used for marking key security concerns.

|}

=== Prefab tips ===

@@ Line 24: / Line 24: @@
 * [[Template:cleanup|<nowiki>{{cleanup}}</nowiki>]] for pages that don't follow the [[Project:Manual of Style|Manual of Style]]
-=== Note templates ===
+=== Notice templates ===
-These templates are purposefully intrusive, and serve as a visual landmark to an important note.
+In general, there are two kinds of notes you can use: ''big'' and ''small'' notices. '''Small notices''' integrate well within the flow of the text, and are meant to convey information that shouldn't distract too much from the reading flow. The table below shows the main small notes available:
-* [[Template:tip|<nowiki>{{tip}}</nowiki>]] for a tip.
+{| class="wikitable" style="width: 100%;"
-* [[Template:warning|<nowiki>{{warning}}</nowiki>]] for a non-security warning.
+ | Template
-* [[Template:Security Warning|<nowiki>{{Security Warning}}</nowiki>]] for a security warning.
+ | Example
+ | Notes
+ |-
+ | {{template link|note}}
+ | {{note|This is some important information}}
+ | To be used for important information that shouldn't break the reading flow.
+ |-
+ | {{template link|aside}}
+ | {{aside|This information is not that important.}}
+ | To be used for related information that is not essential for the main body of an article.
+ |}
-These templates should be used sparingly, but are useful as they are less intrusive.
+'''Big notices''' are purposefully disruptive, and are meant to capture a reader's attention. Use these to convey information that should be read first, especially when the user is glancing over a page without reading it in detail.
-* [[Template:note|<nowiki>{{note}}</nowiki>]] for a note.
-* [[Template:aside|<nowiki>{{aside}}</nowiki>]] for an aside comment about a section.
+{| class="wikitable" style="width: 100%;"
+ | Template
+ | Example
+ | Notes
+ |-
+ | {{template link|tip}}
+ | {{tip|Something you might easily miss}}
+ | To be used for quick reminders that users often miss.
+ |-
+ | {{template link|info}}
+ | {{info|Some key information you should be aware of}}
+ | To be used for bringing key information to the reader's attention.
+ |-
+ | {{template link|warning}}
+ | {{warning|This information is highly important.}}
+ | To be used for marking potentially dangerous, disruptive or destructive actions.
+ |-
+ | {{template link|security Warning}}
+ | {{security Warning|This information is paramount.}}
+ | To be used for marking key security concerns.
+ |}
 === Prefab tips ===