VDR Wiki:Templates

Description

Templates are ready to use constructs of wiki syntax. They are useful for frequently used text or other unchanging things that are used more often.

One can use a template by inserting {{template_name|option1|option2}} in the text. It is then replace by the template content together with the option in the generated text. That means, changing a template changes the text in all articles the template is used in.

If this is not intended prepend a subst: to the template name as in {{subst:template_name}}.

Template list

Here are the templates listed, that exist for VDR Wiki.

These are article skeletons. Create an empty article, place the appropiate template in it (with a prepended subst: before the template name, save the article and edit it again. The basic structure is now in place.

• {{Article (plugin)}}
• {{Article (plugin ext)}}
• {{Article (patch)}}

These are some info boxes. They get the info text as parameter.

• {{Box Info | Text}}
• {{Box Warning | Text}}
• {{Box Critical | Text}}

• {{Box File | /path/to/file | Content}}

• {{Box TOC | Heading | Column 1 | Column 2}}

Standard elements

• {{VDRWiki Header(Standard)}}
• {{VDRWiki Header(Hardware)}}
• {{VDRWiki Header(Software)}}
• {{VDRWiki Footer}}

• {{i18n|article}}
• {{TOC}}

Examples

Create empty article and place

{{subst:Article (plugin)}}

save, and edit again, the content is now in place.

Place this somewhere in an article

{{Box Hint|
This is a hint.
}}

and save it. The resulting page show noch a Box with the text This is a hint in it. Edit it again. Again the call of the template is there, not the content.