Editing a Wiki Page in
ScrewTurn Wiki is really simple. You can insert
WikiMarkup, standard
XHTML or use the integrated
Format Helper Toolbar. In all the cases, you can format the text and insert links, images and many other items in a simple and quick fashion.
1 - WikiMarkup
The
WikiMarkup is a particular set of prefixes and suffixes that allows to format the text and insert items.
1.1 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
1.2 - Links
Links are identified with
[ and
].
- 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.screwturn.eu] produces http://www.screwturn.eu - You can link to an internal file or subdirectory:
[blog/|Blog] produces Blog and [GPL.txt|GPL] produces GPL
1.2.1 - Notes
Links and Images share the same general syntax, but the number of fields changes.
1.3 - 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
1.3.1 - Horizontal Line
You can place a horizontal line using four hyphens
----.
1.4 - Images
Images use
[ and
] as delimiters. 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 o 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
1.4.1 - Notes
Links and Images share the same general syntax, but the number of fields changes.
1.5 - 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 2produces
|
# Element 1 # Element 2produces- Element 1
- Element 2
|
# Element 1 # Element 2 #* Element 2.1 #* Element 2.2 # Element 3produces- Element 1
- Element 2
- Element 3
|
# Element 1 # Element 2 #* Element 2.1 #*# Element 2.1.1 #*#* Element 2.1.1.1 # Element 3produces- Element 1
- Element 2
- Element 3
|
1.6 - 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].
1.7 - 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.
1.8 - 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 myITforum.com 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/Elegant/ (the current theme path){rsspage} produces
(the link to the current Page's RSS feed, available only in Pages){wikiversion} produces 3.0.5.600 (the version of the Wiki engine){mainurl} produces http://www.myITforum.com/myITWiki/ (the Main URL of the Wiki){pagecount} produces 258 (the # of Pages in the Wiki){clear} to use when inserting images at the bottom of a Page
1.9 - Boxes
If you want to wrap some content inside a box, use triple brackets
((( and
))). For example,
(((My box))) produces
My box
1.10 - Text Indentation
The text can be
indented using one or more colons, at the
beginning of a line.
: Single indentation
:: Double indentation
results in
Single indentation
Double indentation
1.11 - Tables
The
WikiMarkup also supports tables. Since the tables offer many options, they are described in the dedicated section
Tables.
1.12 - 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></strong>
2 - Format Helper Toolbar
In the editing page there is the toolbar reported in this picture:
 Format Helper Toolbar |
The list of the buttons is reported below.
- Bold: sets/unsets selected text as bold
- Italic: sets/unsets selected text as italic
- Underlined: sets/unsets selected text as underlined
- Striked: sets/unsets selected text as
striked - H1: sets/unsets selected text as Header Level 1 (unrecommended)
- H2: sets/unsets selected text as Header Level 2
- H3: sets/unsets selected text as Header Level 3
- H4: sets/unsets selected text as Header Level 4 (use sparingly)
- Subscript: sets/unsets selected text as subscript
- Superscript: sets/unsets selected text as superscript
- Hyperlink: allows to insert a hyperlink in the text through a simple wizard
- Images: shows the list of available image formats which, once clicked, allow to insert an image in the text through a simple wizard
- Anchors: shows two items, the first allows to inserts anchors in the text, the second allows to insert links to anchors in the text
- Inline Code: sets/unsets selected text as
code - Block Code: sets/unsets selected text as a block of code
- Box: wraps/unwraps selected text with
(((...))) - Line Break: inserts a single line break in the text
- Special Tags: shows a list of available special tags which, once clicked, insert a specific special tag in the text
- NoWiki: wraps/unwraps selected text with
<nowiwi>...</nowiwi> tags