Help:Template
Here are some nice templates, borrowed from the Arch Wiki.
These templates cut down on ugly wikitext, reduce duplication of effort, and make the wiki look much nicer.
Usage
Templates are used by adding the following markup to an article:
{{Template name}}
Most templates take additional arguments, such as Template:Note:
{{Note|This text should be noted.}}
which produces:
Some templates use named parameters, such as Template:hc:
{{hc|head=/etc/rc.local|output=exit 0}}
which produces:
/etc/rc.local
exit 0
The general format is:
{{Template name|param1|param2|...|paramN}}
See each template's page for specific usage instructions.
Style
- Templates should be used with the capitalization shown in the examples in their pages, for example
{{Pkg|...and{{ic|...are correct, while{{pkg|...and{{Ic|...are not. - There should be no spaces around the template name:
{{Template name|...is correct, while for example{{ Template name |...is not. - Templates should not be categorized.
Escape template-breaking characters
There are some characters that, if used inside a template, will break its output: most frequently this happens with "=" (the equal sign) and "|" (the pipe sign). Solutions to this problem are described below.
Named parameters
If the problem is only with "=" signs, the recommended solution is to explicitly introduce template parameters with their names or positional numbers. This is very useful with query strings in URLs or variable definitions, but will not work for other offending characters, like "|". For example:
{{Tip|1=https://www.archlinux.org/?foo=bar}}
Or, with multiple parameters:
{{hc|1=$ echo "="|2==}}
{{hc|head=$ echo "="|output==}}
$ echo "="
=
nowiki tags
If you are having problems with characters other than "=", e.g. "|", the recommended solution is to enclose the whole parameter in <nowiki> tags. This method displays all kinds of characters, but completely prevents the wiki engine from processing text markup, such as links and other templates. For example:
{{Tip|<nowiki>= | }} https://www.archlinux.org/ {{ic|foo}}</nowiki>}}
Enclosing only specific parts (or even single characters) in <nowiki> tags still works of course, but for readability it is recommended to use such method only if links or other templates have to be normally displayed. For example:
{{Tip|<nowiki>= | }}</nowiki> https://www.archlinux.org/ {{ic|foo}}}}
HTML entities
Replacing the offending characters with their respective HTML entities always works, but since it reduces the readability of the source text, it is recommended only when the solutions above are not practicable. For example:
{{Tip|= | }}}}
Creation
The following template should be used when creating new templates to facilitate usage and editing:
<noinclude>{{Template}}
'''A brief description of the template'''
====Usage====
{{ic|<nowiki>{{Template name|param1|param2|...|paramN}}</nowiki>}}
====Example====
{{Template name|param1|param2|...|paramN}}</noinclude><includeonly>Template code goes here...</includeonly>
To begin the creation process, simply visit Template:Template name (substituting Template name with the desired name of the template), edit, and add the relevant wikitext.
List of templates
The templates that users can use directly in articles on the Coreboot Wiki are listed below. Click on the links to see their detailed usage. For a list that also includes localizations and meta templates see Special:AllPages/Template:, Special:PrefixIndex/Template: or Special:MostLinkedTemplates.