NixOS Wiki

Help:Templates: Difference between revisions

← Older edit
VisualWikitext
mNo edit summary
34j (talk | contribs)
71 edits
Rename to Home Manager
 
(14 intermediate revisions by 5 users not shown)
Line 13: Line 13:
There are other section-specific templates, and templates for internal use available too.
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
|-
| {{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.
|}


=== 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.
{| class="wikitable" style="width: 100%;"
* [[Template:aside|<nowiki>{{aside}}</nowiki>]] for an aside comment about a section.
! 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|category=no|This information is paramount.}}
| To be used for marking key security concerns.
|}


=== Prefab tips ===
=== Prefab tips ===
Line 84: Line 142:
* [[Template:issue|<nowiki>{{issue}}</nowiki>]] to link to a Nixpkgs issue.
* [[Template:issue|<nowiki>{{issue}}</nowiki>]] to link to a Nixpkgs issue.
* [[Template:pull|<nowiki>{{pull}}</nowiki>]] to link to a Nixpkgs pull request.
* [[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 ===
=== Page construction ===
Line 95: Line 154:
== Visual Guidelines ==
== Visual Guidelines ==


The icons used are from [https://community.kde.org/KDE_Visual_Design_Group/HIG/IconDesign Breeze, the default icon set of KDE].
The icons used are from [https://develop.kde.org/hig/icons Breeze, the default icon set of KDE].


Since the icons from Breeze are used, the [https://community.kde.org/KDE_Visual_Design_Group/HIG/Color colours from HIG], which is the ''Breeze Color Palette'' are used.  
Since the icons from Breeze are used, the [https://develop.kde.org/hig/status_changes/#color colours from HIG], which is the ''Breeze Color Palette'' are used.  


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.
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 ==
== See also ==


* [https://wiki.nixos.org/wiki/Special:AllPages?from=&to=&namespace=10 List of all templates]
* [https://wiki.nixos.org/wiki/Special:AllPages?from=&to=&namespace=10 List of all templates]
[[Category:Contributions]]
Retrieved from "https://wiki.nixos.org/wiki/Help:Templates"