Help:Template: Difference between revisions
m Review templates listing... |
m Add short descriptions |
||
| Line 9: | Line 9: | ||
=== Article status === | === Article status === | ||
* [[Template:outdated|<nowiki>{{outdated}}</nowiki>]] | * [[Template:outdated|<nowiki>{{outdated}}</nowiki>]] for when a page or a section is outdated. | ||
* [[Template:expansion|<nowiki>{{expansion}}</nowiki>]] | * [[Template:expansion|<nowiki>{{expansion}}</nowiki>]] for when a page or section needs expansion. | ||
* [[Template:merge|<nowiki>{{merge}}</nowiki>]] | * [[Template:merge|<nowiki>{{merge}}</nowiki>]] for when a a page or a section may need to be merged into another. | ||
* [[Template:disambiguation|<nowiki>{{disambiguation}}</nowiki>]] | * [[Template:disambiguation|<nowiki>{{disambiguation}}</nowiki>]] for when a page name is ambiguous, to link to another. | ||
=== Note templates === | === Note templates === | ||
* [[Template:tip|<nowiki>{{tip}}</nowiki>]] | * [[Template:tip|<nowiki>{{tip}}</nowiki>]] for a tip. | ||
* [[Template:note|<nowiki>{{note}}</nowiki>]] | * [[Template:note|<nowiki>{{note}}</nowiki>]] for a note. | ||
* [[Template:warning|<nowiki>{{warning}}</nowiki>]] | * [[Template:warning|<nowiki>{{warning}}</nowiki>]] for a non-security warning. | ||
* [[Template:Security Warning|<nowiki>{{Security Warning}}</nowiki>]] | * [[Template:Security Warning|<nowiki>{{Security Warning}}</nowiki>]] for a security warning. | ||
=== Prefab tips === | === Prefab tips === | ||
* [[Template:evaluate|<nowiki>{{evaluate}}</nowiki>]] | * [[Template:evaluate|<nowiki>{{evaluate}}</nowiki>]] reminder to evaluate a NixOS configuration with {{ic|nixos-rebuild}}. | ||
* [[Template:unfree|<nowiki>{{unfree}}</nowiki>]] | * [[Template:unfree|<nowiki>{{unfree}}</nowiki>]] a note that a package is unfree, with a link for more help. | ||
=== Formatting === | === Formatting === | ||
* [[Template:commands|<nowiki>{{commands}}</nowiki>]] | * [[Template:commands|<nowiki>{{commands}}</nowiki>]] for a list of commands. | ||
* [[Template:file|<nowiki>{{file}}</nowiki>]] | * [[Template:file|<nowiki>{{file}}</nowiki>]] for a formatted code block with a filename header. | ||
* [[Template:ic|<nowiki>{{ic}}</nowiki>]] | * [[Template:ic|<nowiki>{{ic}}</nowiki>]] for '''inline code'''. | ||
=== Links === | === Links === | ||
* [[Template:issue|<nowiki>{{issue}}</nowiki>]] | * [[Template:issue|<nowiki>{{issue}}</nowiki>]] to link to a Nixpkgs issue. | ||
* [[Template:pull|<nowiki>{{pull}}</nowiki>]] | * [[Template:pull|<nowiki>{{pull}}</nowiki>]] to link to a Nixpkgs pull request. | ||
== Visual Guidelines == | == Visual Guidelines == | ||
Revision as of 02:28, 7 April 2024
The wiki provides templates for common tasks.
Those templates can range from simple to complex, being almost invisible to the end-user to provide a complete harmonized template between articles.
In addition to the visual aspect, using some templates will automatically file and categorize articles in ways indispensable to the end-users.
Available templates
Article status
- {{outdated}} for when a page or a section is outdated.
- {{expansion}} for when a page or section needs expansion.
- {{merge}} for when a a page or a section may need to be merged into another.
- {{disambiguation}} for when a page name is ambiguous, to link to another.
Note templates
- {{tip}} for a tip.
- {{note}} for a note.
- {{warning}} for a non-security warning.
- {{Security Warning}} for a security warning.
Prefab tips
- {{evaluate}} reminder to evaluate a NixOS configuration with
nixos-rebuild. - {{unfree}} a note that a package is unfree, with a link for more help.
Formatting
- {{commands}} for a list of commands.
- {{file}} for a formatted code block with a filename header.
- {{ic}} for inline code.
Links
Visual Guidelines
The icons used are from Breeze, the default icon set of KDE.
Since the icons from Breeze are used, the 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.