Help:Templates: Difference between revisions

Line 8:

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

Line 15:

Line 17:

=== 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:note|<nowiki>{{note}}</nowiki>]] for a note.

* [[Template:warning|<nowiki>{{warning}}</nowiki>]] for a non-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 ===

Common repeated tips in template form.

* [[Template:evaluate|<nowiki>{{evaluate}}</nowiki>]] reminder to evaluate a NixOS configuration with {{ic|nixos-rebuild}}.

Line 27:

Line 37:

=== 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: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:bc|<nowiki>{{bc}}</nowiki>]] for a '''block''' of '''code'''.

=== Links ===

==== Links ====

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

* [[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 ==

@@ Line 8: / Line 8: @@
 === 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.
@@ Line 15: / Line 17: @@
 === 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:note|<nowiki>{{note}}</nowiki>]] for a note.
 * [[Template:warning|<nowiki>{{warning}}</nowiki>]] for a non-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 ===
+Common repeated tips in template form.
 * [[Template:evaluate|<nowiki>{{evaluate}}</nowiki>]] reminder to evaluate a NixOS configuration with {{ic|nixos-rebuild}}.
@@ Line 27: / Line 37: @@
 === 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: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:bc|<nowiki>{{bc}}</nowiki>]] for a '''block''' of '''code'''.
-=== Links ===
+==== Links ====
 * [[Template:issue|<nowiki>{{issue}}</nowiki>]] to link to a Nixpkgs issue.
 * [[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 ==