The WikiMarkup is a particular set of prefixes and suffixes that allow to format the text and insert items, such as links and images. In this section you'll learn how to use the WikiMarkup.

Edit

Basic Text Formatting

• Writing '''bold''' produces bold
• Writing ''italic'' produces italic
• Writing __underlined__ produces underlined
• Writing --striked-- produces striked
• You can use any combination, for example --striked '' '''bold''' and italic''-- produces striked bold and italic

Edit

Links

Links are identified with [ and ].
Note: since version 1.0.10, links also work with 2 brackets, for example [[Link]].

• To insert a link to an internal page just write [PageName], that produces PageName (if the linked Page doesn't exist, the link will have a different color)
• You can add a title to the link: [PageName|This is a Link] produces This is a Link
• Email links are detected automatically, for example [mail@server.com] produces mail@server.com.
  Obviously you can add a title: [mail@server.com|Contact us] becomes Contact us
• External links are marked with a special icon: [http://www.nwtresearch.com] produces http://www.nwtresearch.com
• You can link to an internal file or subdirectory: [../canoe/|CANOE] produces CANOE and [GPL.txt|GPL] produces GPL
• If you add a ^ sign to the URL, the link will open in a new browser window, for example [^MyPage].
• To create an anchor: [Anchor|#name] e.g. [Anchor|#Top]
• You can use Anchors in your page links: [PageName#Anchor|This is a Link with an anchor] produces This is a Link with an anchor.
  Another example is [PageEditing.ashx#BC_-_Links_7|PageEditing/1.2 - Links] Page Editing/1.2 - Links.

You can upload files using the File Management interface.

Edit

Notes

Links and Images share the same general syntax, but the number of fields changes.

Edit

Categories

You can link a Category by using the following syntax:

[c:CategoryName]

For example, you can link the Miscellaneous category or all the uncategorized Pages ([c:-|uncategorized Pages]).

Edit

Page Attachments

You can attach a file to a Page using the following syntax:

[attachment:File.jpg]

Attachment are listed at the bottom of the Page. Please note that this function is still quite "raw", and the attached files are not real attachments, but just links to some uploaded files.

Edit

References

For citing web sites, you would use the following markup:

<ref>cite web|url=http://http://www.nwtresearch.com/licence/scientistsact.aspx|title=NWT Scientists Act</ref>

To display all the references, you would use the following tag:

<references />

Example:

Aurora Research Institute is responsible for licensing and coordinating research in accordance with the NWT Scientists Act^[1]



Edit

Headings

You can create headings using a sequence of equal (=) signs:

• ==Biggest Heading (H1)==
• ===Big Heading (H2)===
• ====Small Heading (H3)====
• =====Smallest Heading (H4)=====
• The first 3 Headings work as separators, the latter is only a small heading (use it sparingly)
• H1 is not recommended because it's used for the Page Title and therefore may cause confusion

Note: headings must be placed at the beginning of lines.

Edit

Horizontal Line

You can place a horizontal line using four hyphens ----.

Edit

Images

Images use [ and ] as delimiters.
Note: since version 1.0.10, images also work with 2 brackets, for example [[image|Title|Url]].
There are several types of images:

• [image|Title|Url|Big Url/Link Url (optional)] inserts an inline image, without borders nor legend
• [imageleft|Title|Url|Big Url/Link Url (optional)] and [imageright|Title|Url|Big Url (optional)] insert images aligned respectively on the left and on the right, displaying borders and a description
• [imageauto|Title|Url|Big Url/Link Url (optional)] inserts an image with automatic alignment, displaying borders and description
• In all the cases, Big Url/Link Url is optional; when specified, it links the image with its big version or with any another document

You can upload images and files using the File Management interface.

Edit

Notes

Links and Images share the same general syntax, but the number of fields changes.

Edit

Lists

A list is made by a sequence of lines starting with one or more asterisks (*) and/or diesis (#). You can create nested list using more than one asterisk or diesis.

* Element 1 * Element 2 produces Element 1 Element 2

# Element 1 # Element 2 produces Element 1 Element 2

# Element 1 # Element 2 #* Element 2.1 #* Element 2.2 # Element 3 produces Element 1 Element 2 Element 2.1 Element 2.2 Element 3

# Element 1 # Element 2 #* Element 2.1 #*# Element 2.1.1 #*#* Element 2.1.1.1 # Element 3 produces Element 1 Element 2 Element 2.1 Element 2.1.1 Element 2.1.1.1 Element 3

Edit

Code and the NoWiki Tag

If you want to insert an inline piece of code, wrap it with {{ and }}; for example {{This is code}} produces This is code.
If you want to insert a block of code, for example a C# class, wrap it with {{{{ and }}}}, as in

using System;

namespace MyNamespace {
   public class HelloWorld {
      public static void Main(string[] args) {
         Console.WriteLine("Hello World");
      }
   }
}

If you want to exclude a block of text from the WikiMarkup formatting, wrap it with <nowiki> and </nowiki>, for example <nowiki>[MyPage]</nowiki> produces [MyPage].

Edit

The @@ Tag

If you need to place some code that contains, for example, XML and even WikiMarkup and you want it to be displayed exactly as is, wrap with with two @:

@ @
<xml>
   '''Bold'''
   <bla z="b" />
</xml>
@ @

Removing the space between the @ signs, the result is:

<xml>
   '''Bold'''
   <bla z="b" />
</xml>

Edit

Line Breaks

Two line breaks are treated as they are. A single line break is ignored. If you want to insert a single line break, you can use the standard XHTML tag <br /> or its WikiMarkup alias {BR} (letter casing is ignored). It's not recommended to abuse single line breaks because they tend to create confusion in the page.

Edit

Special Tags

The ScrewTurn Wiki engine provides a few special markers that are replaced automatically with specific content. All these tags ignore the letter casing.

• {wikititle} produces NWT Research Wiki (the title of the Wiki)
• {up} produces GetFile.aspx?File= (the file upload path)
• {top} produces Top (link to the top of the current Page)
• {toc} produces the Table of Contents of the Page, using Hx headers as titles
• {themepath} produces Themes/Default/ (the current theme path)
• {rsspage} produces (the link to the current Page's RSS feed, available only in Pages)
• {wikiversion} produces 2.0.35 (the version of the Wiki engine)
• {mainurl} produces http://wiki.nwtresearch.com/ (the Main URL of the Wiki)
• {pagecount} produces 638 (the # of Pages in the Wiki)
• {username} inserts the Username of the current user
• {cloud} inserts a Categories Cloud
• {searchbox} inserts a Search Box, with full-text search disabled by default (only one Search Box can be used at a time)
• {ftsearchbox} inserts a Search Box, with full-text search enabled by default
• {clear} to use when inserting images at the bottom of a Page

Edit

Boxes

If you want to wrap some content inside a box, use triple brackets ((( and ))). For example, (((My box))) produces
Edit

Text Indentation

The text can be indented using one or more colons, at the beginning of a line.

: Single indentation
:: Double indentation

results in


Edit

User Signature

Users can sign their edits using four tildes: ~~~~. The result is the following: admin, 2008/03/04 14:06

Edit

Page Redirection

You can redirect a user automatically to another Page when he visits a Page. You can just add the following code at the beginning of the Page:

>>> [PageName]

or

>>> PageName

When the user visits a Page containing a Redirection tag, the engine will display the destination Page. At the top of the destination Page Page, a message will be displayed, containing a link for visiting the origin Page without being redirected.

Edit

XHTML Support and Escaping

ScrewTurn Wiki supports standard XHTML content. You can use any tag, except for <script> that might be disabled by the administrators.
XHTML comments are also supported: <!-- -->.

If you want to insert a block of HTML or XML displaying the tags, you can use the <esc></esc> tag. This tags escapes all the angular brackes making them visible.

<esc><strong>Your tag</strong></esc>

produces

<strong>Your tag</strong>

In the editing page there is the toolbar reported in this picture:

Format Toolbar

The list of the buttons is reported below.

1. Bold: sets/unsets selected text as bold
2. Italic: sets/unsets selected text as italic
3. Underlined: sets/unsets selected text as underlined
4. Striked: sets/unsets selected text as striked
5. H1: sets/unsets selected text as Header Level 1 (unrecommended)
6. H2: sets/unsets selected text as Header Level 2
7. H3: sets/unsets selected text as Header Level 3
8. H4: sets/unsets selected text as Header Level 4 (use sparingly)
9. Subscript: sets/unsets selected text as _subscript
10. Superscript: sets/unsets selected text as ^superscript
11. Page link: allows to insert a link to a Wiki Page using a menu
12. File link: allows to insert a link to an uploaded file
13. External: allows to insert a link to an external destination
14. Image: allows to insert an image using a simple Image Browser
15. Anchors: shows two items, the first allows to inserts anchors in the text, the second allows to insert links to anchors in the text
16. Inline Code: sets/unsets selected text as code
17. Block Code: sets/unsets selected text as a block of code
18. Box: wraps/unwraps selected text with (((...)))
19. Line Break: inserts a single line break in the text
20. Insert Snippet: allows to insert a Snippet using a menu
21. Special Tags: shows a list of available special tags which, once clicked, insert a specific special tag in the text
    • Note: Providers can add items to this menu using the Host object
22. NoWiki: wraps/unwraps selected text with <nowiki>...</nowiki> tags
23. Comment: wraps/unwraps selected text with XHTML comment tags
24. Escape: wraps/unwraps selected text with escape tags

This is the content displayed under the first tab.

The second tab has this content and these tabs. And this is after the inner tabs.

A simple table is composed by a sequence of rows, and each row contains some cells.

{|
| Cell 1.1
| Cell 1.2
|-
| Cell 2.1
| Cell 2.2
|}

will results in

Cell 1.1	Cell 1.2
Cell 2.1	Cell 2.2

Depending on the theme you are using, tables' appearance might differ.
The same results can be obtained using the form

{|
| Cell 1.1 || Cell 1.2
|-
| Cell 2.1 || Cell 2.2
|}

As you can see, a table starts with {| and ends with |}. A single pipe starts a cell of the table, while a pipe with a hyphen (|-) starts a new row in the table. A double pipe separates two or more cells in the same row.

A table can have a caption (or title). You can specify it using a pipe and plus, just after the opening tag.

{|
|+ This is a Table
| Cell 1.1 || Cell 1.2
|-
| Cell 2.1 || Cell 2.2
|}

produces

This is a Table

Cell 1.1	Cell 1.2
Cell 2.1	Cell 2.2

You can also use row and cell headers; they are identified with a exclamation mark.

{|
! Cells x.1 !! Cells x.2
|-
| Cell 1.1 || Cell 1.2
|-
| Cell 2.1 || Cell 2.2
|}

generates

Cells x.1	Cells x.2
Cell 1.1	Cell 1.2
Cell 2.1	Cell 2.2

You can use row headers as well.

{|
! X !! x.1 !! x.2
|-
! 1.x
| Cell 1.1 || Cell 1.2
|-
! 2.x
| Cell 2.1 || Cell 2.2
|}

generates

X	x.1	x.2
1.x	Cell 1.1	Cell 1.2
2.x	Cell 2.1	Cell 2.2

You can modify the appearance of a table (and each row or cell) using XHTML tags.

{| border="1" bgcolor="Gray"
| Cell 1.1 || Cell 1.2
|-
| Cell 2.1 || Cell 2.2
|}

generates

Cell 1.1	Cell 1.2
Cell 2.1	Cell 2.2

You can also modify the appearance of single rows. In this case, you can add a trailing row separator manually.

{| cellspacing="0" cellpadding="2" border="1"
|- style="background-color: Red; color: White;"
| Cell 1.1 || Cell 1.2
|- style="font-weight: bold;"
| Cell 2.1 || Cell 2.2
|}

results in

Cell 1.1	Cell 1.2
Cell 2.1	Cell 2.2

Even single cells can be styled.

{|
| bgcolor="Blue" | Styled Cell
| Normal cell
|-
| Normal cell
| bgcolor="Yellow" | Styled cell
|}

Styled Cell	Normal cell
Normal cell	Styled cell

You can use XHTML attributes to merge two or more cells (horizontally or vertically).
Note: not all the the browsers support this feature.

{|
| colspan="2" bgcolor="Red" | Cell
|-
| Cell || Cell
|}

generates

Cell
Cell	Cell

While

{|
| rowspan="2" bgcolor="Red" | Cell
| Cell
|-
| Cell
|}

results in

Cell	Cell
	Cell

You can align a table to the right or place it in the center of the page.

{| align="right" border="1"
| Cell || Cell
|}

produces

Cell

Cell

while

{| style="margin: 0px auto;" border="1"
| Cell || Cell
|}

results in

Cell

Cell

{| cellspacing="0" cellpadding="2" style="background-color: #EEEEEE;"
|+ Styled Table
|- style="background-color: #990000; color: #FFFFFF;"
| This is a cell || This is a cell || This is a cell
|-
| style="background-color: #000000; color: #CCCCCC;" | Styled cell
| style="border: solid 1px #FF0000;" | Styled cell
| '''Normal cell'''
|-
| Normal || Normal || [Download]
|}

produces

Styled Table

This is a cell	This is a cell	This is a cell
Styled cell	Styled cell	Normal cell
Normal	Normal	Download

Depending on the Wiki configuration, Users and/or Administrators can create new Categories, and assign them to Pages. This task, also named binding can be accomplished in the editing page, as displayed in the picture on the right.

Edit

Configuration Limitations

As reported above, the actions that simple Users can performs with Categories can be limited, depending on the Configuration on the Wiki. Administrators can decide whether or not allow Users to:

• create new Categories

and/or

• change the Categories bindings of a Page (they anyway need to have editing permissions on that Page)

Edit

Categories, Pages and Providers

Categories and Pages can be managed by different Providers. A Page can be bound with a Category only if they are managed by the same Provider.

Administrators can manage the Categories using the Categories tab of the administration interface, displayed in the picture. The Categories are listed, and their Provider is displayed in the list.

You can perform several operations, described in this section.

Edit

Deleting Categories

You can delete a Category by selecting it in the list and then clicking on the Delete button.

Note: by deleting a Category, the system does not delete the Pages that are bound with it.

Edit

Renaming Categories

You can rename a Category by selecting it in the list, typing the new name in the textbox and then clicking on the Rename to button. This won't affect Pages.

Edit

Creating a new Category

You can create a new Category by typing the desired name in the textbox and then clicking on the Create New button. You can select the Provider to use for storing the new Category.

Edit

Merging Categories

You can merge two Categories (if they are managed by the same Provider) by selecting one Category in the main list, then selecting the destination Categories in the listbox (see picture) and finally clicking on the Merge With button. You will be asked to confirm the operation.

The result of Categories Merging is that the Category selected in the main list will be removed, and all the Pages bound with it will be re-bound with the second Category, i.e. the one selected in the listbox near the Merge with button.

In the list are displayed both directories and files, in alphabetical order. You can see different icons for directories () and files (). By clicking on a directory name, you change the current directory. By clicking on a file name, you download it.

On the right of the directory or file name there is, respectively, the number of items contained in the directory and the size of the file.

Files also have the WikiMarkup link displayed on the right. You can use it to insert links to files manually.

If you are currently working in a subdirectory, the first item in the list is the "Up one level" button (), that lets you move one level up in the directory structure.

In order to upload a file, you should first select the subdirectory you want to save file in (if needed), then click on the Browse button, select a file on your hard disk, and click the Upload button.

If the file you are attempting to upload already exists, you should first delete it, or you can overwrite it while uploading by selecting the checkbox on the right of the Browse button.

You can create a new directory using the textbox available on the top of the file list: insert the name of the directory you want to create, and click on the New Directory button.

To delete an item, select its checkbox on the left of the list, then click on the Delete Selected button.

Notes: you can delete as many items as you want in a single operation. When deleting a directory, all the items inside it will be deleted too.

You can rename both files and directories by clicking on the Rename icon on the left of the item name (). When you click on it, the Rename tool appears at the top of the list:

The Rename tool

Just type the new name and then click on the Rename button. If you are renaming a file and you don't specify an extension, the system will append the original extension automatically.

A snippet can be inserted by simply using the following syntax:

{s:SnippetName}

where SnippetName is the name of the snippet you want to insert (case insensitive).

You can add a snippet in a Page or in any of the "meta" files (Sidebar, Header, etc.). Snippets are "resolved" recursively, so you can insert a Snippet into another. If you insert a non-existent Snippet, you will get a red warning in the Page stating "FORMATTER ERROR (Snippet Not Found)."

Edit

Example

To produce a reusable Draft snippet like this:


you should paste the following code into a new Snippet named Draft in the administration interface (see next section):

<div style="border-top: solid 2px #FED626; border-bottom: solid 2px #FED626; padding: 4px 4px 4px 36px; vertical-align: middle; 
background-color: #FFF7C0; background-image: url({UP}Alert.png); background-repeat: no-repeat; background-position: 10px center;">
This page is a ''Draft'', its content is not complete and might contain errors.
</div>

You then should upload the Alert.png file into your Wiki using the File Management page.

Edit

Toolbar

You can also insert a Snippet using the handy "Insert a Snippet" button of the editing Toolbar, which displays a menu containing all the available Snippets.

The Snippets tab of the administration interface allows you to create, edit and delete snippets. The list displays the existing Snippets and their Provider.

Edit

Creating a new Snippet

To create a new Snippet, click on the New button and insert the Snippet name and content. You can also select the Provider to use for the new Snippet. When you are finished, click on the Save Snippet button.

Edit

Deleting a Snippet

To delete a Snippet, select it in the list and then click on the Delete button. You will be asked to confirm the operation.

Edit

Modifying a Snippet

You can edit the content of a Snippet (but not the Name). To do so, select it in the list and then click on the Edit button. Modify the content, and then click on the Save Snippet button.

Since version 2.0.25, Snippets can be parameterized. A parameterized Snippet reads something like this:

This is a ?1? Snippet. Is it cool? ?2?

A mark like ?n? represent the placeholder for the nth snippet parameter, which will be replaced at runtime with the specified value. In order to specify the value, add a Snippet with the following markup (assume the Snippet reported above is called MySnip):

{s:MySnip|parameterized|Yes, it is!}

The output will be:

This is a parameterized Snippet. Is it cool? Yes, it is!

As you see, parameterized is the first parameter, Yes, it is! is the second. You can specify as many parameters as you need, and they can also be blank, but they cannot contain CRLF characters (in other words, you cannot start a new line in the middle of a Snippet declaration). A parameter cannot contain pipes; if you need them, just use the corresponding HTML escape sequence |.

You can transclude a whole Page into another just by using the following syntax:

{t:PageToTransclude}

Where PageToTransclude is the name of the Page that has to be included in the current.

The following code includes the Main Page into this one:

{t:MainPage}

Here is the result (the separation line is added using four hyphens, as described in the Page Editing Help):

» AlbumDemo
clouds	sky	trees	wind

Edit

Usage

{Album:FolderName}

FolderName is the folder which you have uploaded your images to.

You can specify to start navigation on a subdirectory by:

{ Album:FolderName\SubFolder}

Edit

Usage

{SlideShow:FolderName}

FolderName is the folder which you have uploaded your images to.