Help:Template: Difference between revisions
m Add short descriptions |
m Add words |
||
| Line 8: | Line 8: | ||
=== Article status === | === Article status === | ||
These templates should be added to either the top of a page, or the top of a section, when needed. | |||
* [[Template:outdated|<nowiki>{{outdated}}</nowiki>]] for when a page or a section is outdated. | * [[Template:outdated|<nowiki>{{outdated}}</nowiki>]] for when a page or a section is outdated. | ||
| Line 15: | Line 17: | ||
=== Note templates === | === Note templates === | ||
These templates are purposefully intrusive, and serve as a visual landmark to an important note. | |||
* [[Template:tip|<nowiki>{{tip}}</nowiki>]] for a tip. | * [[Template:tip|<nowiki>{{tip}}</nowiki>]] for a tip. | ||
* [[Template:warning|<nowiki>{{warning}}</nowiki>]] for a non-security warning. | * [[Template:warning|<nowiki>{{warning}}</nowiki>]] for a non-security warning. | ||
* [[Template:Security Warning|<nowiki>{{Security Warning}}</nowiki>]] for a security warning. | * [[Template:Security Warning|<nowiki>{{Security Warning}}</nowiki>]] for a security warning. | ||
These templates should be used sparingly, but are useful as they are less intrusive. | |||
* [[Template:note|<nowiki>{{note}}</nowiki>]] for a note. | |||
* [[Template:aside|<nowiki>{{aside}}</nowiki>]] for an aside comment about a section. | |||
=== Prefab tips === | === Prefab tips === | ||
Common repeated tips in template form. | |||
* [[Template:evaluate|<nowiki>{{evaluate}}</nowiki>]] reminder to evaluate a NixOS configuration with {{ic|nixos-rebuild}}. | * [[Template:evaluate|<nowiki>{{evaluate}}</nowiki>]] reminder to evaluate a NixOS configuration with {{ic|nixos-rebuild}}. | ||
| Line 27: | Line 37: | ||
=== Formatting === | === Formatting === | ||
==== Misc. prefabs ==== | |||
* [[Template:app|<nowiki>{{app}}</nowiki>]] for a ''card'' with details about an application. | |||
* [[Template:man|<nowiki>{{man}}</nowiki>]] to refer to a man page (and section). | |||
==== Code and commands ==== | |||
* [[Template:commands|<nowiki>{{commands}}</nowiki>]] for a list of commands. | * [[Template:commands|<nowiki>{{commands}}</nowiki>]] for a list of commands. | ||
* [[Template:file|<nowiki>{{file}}</nowiki>]] for a formatted code block with a filename header. | * [[Template:file|<nowiki>{{file}}</nowiki>]] for a formatted code block with a filename header. | ||
* Prefer the SyntaxHighlight extension with e.g. <code><nowiki><syntaxhighlight lang="nix"></syntaxhighlight></nowiki></code> otherwise. | |||
These are more raw implementation blocks. They are not recommended for broad use. | |||
* [[Template:ic|<nowiki>{{ic}}</nowiki>]] for '''inline code'''. | * [[Template:ic|<nowiki>{{ic}}</nowiki>]] for '''inline code'''. | ||
* [[Template:bc|<nowiki>{{bc}}</nowiki>]] for a '''block''' of '''code'''. | |||
=== Links === | ==== Links ==== | ||
* [[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. | ||
=== Page construction === | |||
Templates helping in building pages with common forms. | |||
* [[Template:lowercase title|<nowiki>{{lowercase title}}</nowiki>]] to lowercase the first character of a page name. | |||
* [[Template:main|<nowiki>{{main}}</nowiki>]] to refer back to a main article. | |||
* [[Template:PrefixIndex|<nowiki>{{PrefixIndex}}</nowiki>]] to add a list of pages starting with a given prefix. | |||
== Visual Guidelines == | == Visual Guidelines == | ||
Revision as of 02:43, 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
These templates should be added to either the top of a page, or the top of a section, when needed.
- {{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
These templates are purposefully intrusive, and serve as a visual landmark to an important note.
- {{tip}} for a tip.
- {{warning}} for a non-security warning.
- {{Security Warning}} for a security warning.
These templates should be used sparingly, but are useful as they are less intrusive.
Prefab tips
Common repeated tips in template form.
- {{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
Misc. prefabs
Code and commands
- {{commands}} for a list of commands.
- {{file}} for a formatted code block with a filename header.
- Prefer the SyntaxHighlight extension with e.g.
<syntaxhighlight lang="nix"></syntaxhighlight>otherwise.
These are more raw implementation blocks. They are not recommended for broad use.
Links
Page construction
Templates helping in building pages with common forms.
- {{lowercase title}} to lowercase the first character of a page name.
- {{main}} to refer back to a main article.
- {{PrefixIndex}} to add a list of pages starting with a given prefix.
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.