Getting Started Templates

From Visual WebGui Wiki

Contents 1 General 2 How to use the templates 3 Why do we use templates 4 Visual WebGui Wiki standard templates 4.1 {{msgRequiresContent}} 4.2 {{msgBeingWorkedOn}} 4.3 {{msgBeingWorkedOn | name=Palli}} 4.4 {{msgNeedsWork}} 4.5 {{msgNeedsWork | sections = See sections General and References}} 4.6 {{MsgNewSectionsAddedSoon| type = Type of article}} 4.7 {{msgInaccurate}} 4.8 {{msgInappropriate}} 4.9 {{msgSectionNeedsWork}} 4.10 {{MsgNeedsCSharpcode}} 4.11 {{MsgNeedsVB.NETcode}} 4.12 {{msgBox}} 5 More advanced use of the templates

General

Templates are just a blocks of template (standard) text with markups that works just like include statements. Calling a template simply "includes" and "expands" the template, based on the parameters used to call the template.

Templates are therefore a convenient way of pre-preparing a specially formatted blocks of text which you can then use (call) in your article(s) with minimal efforts.

See Getting Started FCKEditor for more about the templates and how to call them in your articles.

How to use the templates

For the standard templates you either use FCKEditor for help or you simply enter the text {{msgRequiresContent}} which will include the template at that spot in your article. Some templates can take parameters, as you can see below. Templates that take parameters, usually require you to edit the template statement manually without being able to use FCKEditor to fully complete the statement.

Templates can be edited, as they are just normal Wiki pages. Creating templates is very easy, so if you find that you would benefit from having more templates than are presented below, please send us a note or create one your self. For easy distinction, templates are kept in a seperate namespace, but that's just by convention. Any page can be included in any other page by calling it via a template call. If the called page does not reside in the Template namespace, you must preceed it with the correct namespace.

Opening a template (like clicking any link below), you can then click on the "What links here" link on left navigation area to see where the template is currently used.

Why do we use templates

We use templates just for our convenience, for quickly marking or notifying to everyone else something worth notifying about individual articles or article parts. By reviewing our standard templates below, you will quickly recognize how to use them.

Visual WebGui Wiki standard templates

{{msgRequiresContent}}

This article missing it's contents and needs writing. Please help contributing to this wiki and add contents.

{{msgBeingWorkedOn}}

This article is being worked on by Gizmox. Please do not change it's contents in the meantime.

{{msgBeingWorkedOn | name=Palli}}

This article is being worked on by Palli. Please do not change it's contents in the meantime.

{{msgNeedsWork}}

This article needs more work to complete. Please feel free to contribute to this wiki and add contents. To locate the areas in the article where more work is needed, check for specially marked sessions that need more work.

{{msgNeedsWork | sections = See sections General and References}}

This article needs more work to complete. Please feel free to contribute to this wiki and add contents. See sections General and References

{{MsgNewSectionsAddedSoon| type = Type of article}}

This article will have a few sections added to it soon, based on the following article type skeleton: NewCodeSampleTemplate

This article will have a few sections added to it soon, based on the following article type skeleton: NewControlTemplate

This article will have a few sections added to it soon, based on the following article type skeleton: NewArticleTemplate

{{msgInaccurate}}

The contents of this page are inaccurate or out of date. Please contribute to the wiki and update it's contents

{{msgInappropriate}}

The contents of this page is inappropriate for this Wiki and need to be replaced or removed.

{{msgSectionNeedsWork}}

This part of the article has not been completed yet. Please feel free to contribute and add contents to the Wiki

{{MsgNeedsCSharpcode}}

The conversion of this code to C# has not been completed yet. Please feel free to contribute and add contents to the Wiki Free conversion of simple code snippets can be found at http://www.developerfusion.com/tools/convert/vb-to-csharp/

{{MsgNeedsVB.NETcode}}

The conversion of this code to VB.NET has not been completed yet. Please feel free to contribute and add contents to the Wiki Free conversion of simple code snippets can be found at http://www.developerfusion.com/tools/convert/csharp-to-vb/

{{msgBox}}

Whatever text you like. Simply add text template variable to get the text

More advanced use of the templates

The ideas used for those templates are based on information from another Wiki. The "messagebox" templates above all use one common template, with different parameters. You can choose to use that common template yourself for more advanced or different templates of your own.

The types of icons available in that common template you can see below.

Type of box is delete

Type of box is content

Type of box is style

Type of box is move

Type of box is protection

Type of box is notice