Page Structure
When formulating a page please try to keep related content in a single page, breaking it up using headers, anchors and a table of contents if necessary to aid with navigation. Avoid, if at all possible, creating pages that contain little information or that require navigation to another page to fully comprehend.
For example, try not to create a separate page for an introduction that contains one or two paragraphs while the other content is located on another page. Instead, create a single page with both the introduction and content combined and use headers and a table of contents to make navigation simpler.
A small page is acceptable in the event that it covers a single topic that does not specifically belong with other content. As a guideline think about whether or not you would link to the page from some other page, and whether or not you would be able to name the link in one or two words.
The rest of this page highlights conventions and markup that should be used when structuring a page.
Headers
Within the wiki we use the following formatting:
* Headers (h1):==This is h1 header==will result in:
This is h1 header
use this tag to denote main sections in wiki pages.
* Headers (h2):===This is h2 header===will result in:
This is h2 header
use this tag to denote main subsections in wiki pages.
* Headers (h3):====This is h3 header====will result in:
This is h3 header
use this tag to denote topics within subsections in wiki pages.
Paragraphs
Within paragraphs use the following formatting:
Paragraphs
Paragraphs are written without any additional formatting, and are separated by an empty line
Code elements
Mark small code elements within paragraph, like names of classes or methods.
{{Console.WriteLine}}
will result in:
Console.WriteLineCode snippets
For bigger code snippets use the following formatting:
@@ language
public static void Main()
{
Console.WriteLine("Hello World");
}@@
The 'language' parameter is used to tell the syntax highlighter how to color the code snippet. The default language is C# (csharp). The languages supported can be found
here.
The code snippet above will appear in the wiki as:
public static void Main()
{
Console.WriteLine("Hello World");
}Special sections
There are a few special sections (defined as snippets) usable in several situations:
Tip
Writing the following:
{s:tip|This is header|This is body}will result in:
This is header
This is body
Use tips to describe suggested practice, useful pattern etc.
Info
Writing the following:
{s:info|This is header|This is body}will result in:
This is header
This is body
Use infos to describe important information, like for example framework's behavior in certain situation.
Warning
Writing the following:
{s:warning|This is header|This is body}will result in:
This is header
This is body
Use warnings to describe pitfalls, potentially dangerous API, and discouraged practices.
Comment
Writing the following:
{s:comment|This is body}will result in:
 This is body |
Use comments to describe unreleased API changes etc...
Table of content
Writing the following:
{TOC}Will result in:
Use table of content for longer articles, where it would be beneficial to be able to jump right into the appropriate section. Alternatively consider breaking the article into several smaller ones.
Standard sections¶
To ensure consistency between pages in the wiki, use the following standard sections in the documents:
(h2) See also
Use this section for links to other related articles within the wiki.
(h2) External resources
Use this section for links to related websites outside of the wiki (like blogposts). When linking blogposts do provide date when they were written.