Difference between revisions of "Help:Template"
(Added info on how to see the template injection syntax) |
m (emphasized link) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{BoxDanger|Viewing the template inject syntax|You can examine how the templates are called by clicking the edit link. ''' | {{BoxDanger|Viewing the template inject syntax|You can examine how the templates are called by clicking the edit link. '''Never modify the templates''' as changes will reflect on all documents where the template is injected! Use this '''[[Help_talk:Template|discussion link]]''' before you make any changes.}} | ||
==Using templates== | ==Using templates== | ||
| Line 11: | Line 11: | ||
<pre>{{File|file=filename|content=content}}</pre> | <pre>{{File|file=filename|content=content}}</pre> | ||
==Command templates== | ==Template Collection== | ||
===Command templates=== | |||
To emphazise if an example command in a document is assuming root or user context | To emphazise if an example command in a document is assuming root or user context | ||
{{RootCmd|command=command}} | {{RootCmd|command=command}} | ||
{{UserCmd|command=command}} | {{UserCmd|command=command}} | ||
==File and content sample== | ===File and content sample=== | ||
When you want to describe how to modify an given file's content. This is a little more work but produces a nice result. Because the content of configuration file often - if not always include '''=''' operator - it is necessary to use named variables when passing values to the template. | When you want to describe how to modify an given file's content. This is a little more work but produces a nice result. Because the content of configuration file often - if not always include '''=''' operator - it is necessary to use named variables when passing values to the template. | ||
<pre>{{File|file=Filename|content=Content}}</pre> | <pre>{{File|file=Filename|content=Content}}</pre> | ||
| Line 32: | Line 33: | ||
}} | }} | ||
== | ===Boxes=== | ||
Boxes are helpers - they are not the document - so don't over-do it. | Boxes are helpers - they are not the document - so don't over-do it. | ||
One way to draw attention to a point is the '''Important''' template which is a simplified verison of the '''BoxInfo template''' as you can see from below samples | One way to draw attention to a point is the '''Important''' template which is a simplified verison of the '''BoxInfo template''' as you can see from below samples | ||
| Line 38: | Line 39: | ||
{{Important|It is not possible to run `makepkg` as root!}} | {{Important|It is not possible to run `makepkg` as root!}} | ||
=== | ====Box Templates==== | ||
{{BoxPrimary|Header|This is a BoxPrimary template}} | {{BoxPrimary|Header|This is a BoxPrimary template}} | ||
{{BoxSecondary|Header|This is a BoxSecondary template}} | {{BoxSecondary|Header|This is a BoxSecondary template}} | ||
Latest revision as of 10:59, 2 October 2020
Using templates
Templates help to create a consistent look and feel to various elements. A template is referenced using the TemplateName and one or more arguments.
To use a template in any document reference the template and separate arguments with pipes |. The general format for injecting a template looks like this
{{TemplateName|argument1|argument2}}
There are exceptions - when the argument contains the = operator - in which case the template is using named arguments and format for injecting a template with named arguments
{{File|file=filename|content=content}}
Template Collection
Command templates
To emphazise if an example command in a document is assuming root or user context
File and content sample
When you want to describe how to modify an given file's content. This is a little more work but produces a nice result. Because the content of configuration file often - if not always include = operator - it is necessary to use named variables when passing values to the template.
{{File|file=Filename|content=Content}}
The best result is achieved by using the pre tag inside the content.
# set PATH so it includes user's private bin if it exists export QT_QPA_PLATFORMTHEME="qt5ct" export GTK2_RC_FILES="$HOME/.gtkrc-2.0" export EDITOR=/usr/bin/nano export VISUAL=/usr/bin/nano
Boxes
Boxes are helpers - they are not the document - so don't over-do it. One way to draw attention to a point is the Important template which is a simplified verison of the BoxInfo template as you can see from below samples
{{Important|It is not possible to run `makepkg` as root!}}