Help:Templates: Difference between revisions

(9 intermediate revisions by 2 users not shown)

Line 13:

There are other section-specific templates, and templates for internal use available too.

=== ~~Article status~~ ===

=== Status notices ===

~~These templates should be added~~ to ~~either~~ the ~~top~~ of ~~a page~~, or ~~the top of~~ a section~~, when needed~~.

'''Status notices''' are essential to our own housekeeping, as well as making the reader aware of certain caveats related to articles. They generally prompt the reader to contribute, edit, navigate or otherwise exercise caution when reading a certain article or section.

* [[Template~~:outdated~~|~~<nowiki>~~{{~~outdated~~}}~~</nowiki>]] for when a page or a section is outdated.~~

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

* [[Template:expansion|~~<nowiki>~~{{~~expansion~~}}~~</nowiki>]] for when~~ a page ~~or section needs expansion.~~

! Template

* [[Template:merge|~~<nowiki>~~{{merge}}~~</nowiki>]] for when a a page or a section may need to be merged into another.~~

! Example

* [[Template:disambiguation|~~<nowiki>~~{{~~disambiguation~~}}~~</nowiki>]] for when~~ a page ~~name is ambiguous, to link to another.~~

! Notes

* [[Template:low quality|~~<nowiki>~~{{~~low quality~~}}~~</nowiki>]] for when a page or a section is of low quality.~~

|-

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

| {{tl|disambiguation}}

| {{disambiguation|category=no|Help:Help}}

| Sometimes a single page can refer to more than one thing; use this template to link to the other pages

|-

| {{tl|merge}}

| {{merge|category=no|Help:Help}}

| If two pages are closely related, they might become merge candidates. Use this template to propose a page merger

|-

| {{tl|cleanup}}

| {{cleanup|category=no}}

| Use this to mark articles or pages that don't follow the [[Project:Manual of Style|Manual of Style]]

|-

| {{tl|low quality}}

| {{low quality|category=no}}

| Use this template to mark articles that are poorly written, are not substantial enough, or that have big issues and don't meet our standards of quality

|-

| {{template link|expand}}

| {{expand|category=no}}

| Use this template to mark articles that contain too little information

|-

| {{tl|outdated}}

| {{outdated|category=no}}

| When the information in an article becomes stale, you can use this template to prompt the user to take the information with a grain of salt, and prompt other editors to contribute by updating it.

|-

| {{tl|delete}}

| {{delete|category=no}}

| When the relevance of an article can be disputed, or is otherwise not needed on the wiki, it can be proposed for deletion. In that case, this template is to be used.

|}

=== Notice templates ===

Line 29:

Line 56:

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

| Template

! Template

| Example

! Example

| Notes

! Notes

|-

| {{template link|note}}

Line 43:

Line 70:

'''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.

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

| Template

! Template

| Example

! Example

| Notes

! Notes

|-

| {{template link|tip}}

Line 63:

Line 89:

|-

| {{template link|security Warning}}

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

| {{security Warning|category=no|This information is paramount.}}

| To be used for marking key security concerns.

|}

Line 116:

Line 142:

* [[Template:issue|<nowiki>{{issue}}</nowiki>]] to link to a Nixpkgs issue.

* [[Template:pull|<nowiki>{{pull}}</nowiki>]] to link to a Nixpkgs pull request.

* [[Template:home manager|<nowiki>{{home manager}}</nowiki>]] links to a given Home Manager option search result.

=== Page construction ===

Line 132:

Line 159:

Sometimes, there isn't an icon in the Breeze theme that can be used for the purpose. In this case, alternative free and open source icons can be used. Once a stand-in is used, someone with the necessary skills can create the needed icon in the breeze style.

== Magic words ==

There are a number of syntax elements in MediaWiki that have special functionality, usually relevant to how the page is presented to the reader, but also useful in template development. Read more on the [[Help:Magic words|magic words help page]].

== See also ==

@@ Line 13: / Line 13: @@
 There are other section-specific templates, and templates for internal use available too.
-=== Article status ===
+=== Status notices ===
-These templates should be added to either the top of a page, or the top of a section, when needed.
+'''Status notices''' are essential to our own housekeeping, as well as making the reader aware of certain caveats related to articles. They generally prompt the reader to contribute, edit, navigate or otherwise exercise caution when reading a certain article or section.
-* [[Template:outdated|<nowiki>{{outdated}}</nowiki>]] for when a page or a section is outdated.
+{| class="wikitable" style="width: 100%;"
-* [[Template:expansion|<nowiki>{{expansion}}</nowiki>]] for when a page or section needs expansion.
+ ! Template
-* [[Template:merge|<nowiki>{{merge}}</nowiki>]] for when a a page or a section may need to be merged into another.
+ ! Example
-* [[Template:disambiguation|<nowiki>{{disambiguation}}</nowiki>]] for when a page name is ambiguous, to link to another.
+ ! Notes
-* [[Template:low quality|<nowiki>{{low quality}}</nowiki>]] for when a page or a section is of low quality.
+ |-
-* [[Template:cleanup|<nowiki>{{cleanup}}</nowiki>]] for pages that don't follow the [[Project:Manual of Style|Manual of Style]]
+ | {{tl|disambiguation}}
+ | {{disambiguation|category=no|Help:Help}}
+ | Sometimes a single page can refer to more than one thing; use this template to link to the other pages
+ |-
+ | {{tl|merge}}
+ | {{merge|category=no|Help:Help}}
+ | If two pages are closely related, they might become merge candidates. Use this template to propose a page merger
+ |-
+ | {{tl|cleanup}}
+ | {{cleanup|category=no}}
+ | Use this to mark articles or pages that don't follow the [[Project:Manual of Style|Manual of Style]]
+ |-
+ | {{tl|low quality}}
+ | {{low quality|category=no}}
+ | Use this template to mark articles that are poorly written, are not substantial enough, or that have big issues and don't meet our standards of quality
+ |-
+ | {{template link|expand}}
+ | {{expand|category=no}}
+ | Use this template to mark articles that contain too little information
+ |-
+ | {{tl|outdated}}
+ | {{outdated|category=no}}
+ | When the information in an article becomes stale, you can use this template to prompt the user to take the information with a grain of salt, and prompt other editors to contribute by updating it.
+ |-
+ | {{tl|delete}}
+ | {{delete|category=no}}
+ | When the relevance of an article can be disputed, or is otherwise not needed on the wiki, it can be proposed for deletion. In that case, this template is to be used.
+ |}
 === Notice templates ===
@@ Line 29: / Line 56: @@
 {| class="wikitable" style="width: 100%;"
-  | Template
+  ! Template
-  | Example
+  ! Example
-  | Notes
+  ! Notes
   |-
   | {{template link|note}}
@@ Line 43: / Line 70: @@
 '''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.
 {| class="wikitable" style="width: 100%;"
-  | Template
+  ! Template
-  | Example
+  ! Example
-  | Notes
+  ! Notes
   |-
   | {{template link|tip}}
@@ Line 63: / Line 89: @@
   |-
   | {{template link|security Warning}}
-  | {{security Warning|This information is paramount.}}
+  | {{security Warning|category=no|This information is paramount.}}
   | To be used for marking key security concerns.
   |}
@@ Line 116: / Line 142: @@
 * [[Template:issue|<nowiki>{{issue}}</nowiki>]] to link to a Nixpkgs issue.
 * [[Template:pull|<nowiki>{{pull}}</nowiki>]] to link to a Nixpkgs pull request.
+* [[Template:home manager|<nowiki>{{home manager}}</nowiki>]] links to a given Home Manager option search result.
 === Page construction ===
@@ Line 132: / Line 159: @@
 Sometimes, there isn't an icon in the Breeze theme that can be used for the purpose. In this case, alternative free and open source icons can be used. Once a stand-in is used, someone with the necessary skills can create the needed icon in the breeze style.
+== Magic words ==
+{{main|Help:Magic words}}
+There are a number of syntax elements in MediaWiki that have special functionality, usually relevant to how the page is presented to the reader, but also useful in template development. Read more on the [[Help:Magic words|magic words help page]].
 == See also ==