Difference between revisions of "Help:Template"
Help page
m |
(Added information on the file content template) |
||
| Line 13: | Line 13: | ||
You can utilize different boxtypes setting both the header and the content | You can utilize different boxtypes setting both the header and the content | ||
{{BoxPrimary|Header|This is a BoxPrimary template}}{{BoxSecondary|Header|This is a BoxSecondary template}}{{BoxInfo|Header|This is a BoxInfo template}}{{BoxSuccess|Header|This is a BoxSuccess template}}{{BoxWarning|Header|This is a BoxWarning template}}{{BoxDanger|Header|This is a BoxDanger template}}{{BoxLight|Header|This is a BoxLight template}}{{BoxDark|Header|This is a BoxDark template}} | {{BoxPrimary|Header|This is a BoxPrimary template}} | ||
{{BoxSecondary|Header|This is a BoxSecondary template}} | |||
{{BoxInfo|Header|This is a BoxInfo template}} | |||
{{BoxSuccess|Header|This is a BoxSuccess template}} | |||
{{BoxWarning|Header|This is a BoxWarning template}} | |||
{{BoxDanger|Header|This is a BoxDanger template}} | |||
{{BoxLight|Header|This is a BoxLight template}} | |||
{{BoxDark|Header|This is a BoxDark template}} | |||
The same can be done when you need 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 '''=''' it is need to use named variables when passing values to the template. | |||
<pre>{{File|file=Filename|content=Content}}</pre> | |||
The best result is achieved by using the '''pre''' inside the content. | |||
{{File|file=~/.profile| | |||
content= | |||
<pre> | |||
# 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 | |||
</pre> | |||
}} | |||
Revision as of 14:07, 28 September 2020
To use a template in any document reference the template and separate arguments with pipes |.
As an example you can create a box to emphasize an important information
{{Important|It is not possible to run `makepkg` as root!}}
Which will give this result in the final document
Templates are helpers - they are not the document - so don't over do it.
You can utilize different boxtypes setting both the header and the content
The same can be done when you need 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 = it is need to use named variables when passing values to the template.
{{File|file=Filename|content=Content}}
The best result is achieved by using the pre inside the content.
~/.profile
# 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