Editing a page is really simple. You can insert
WikiMarkup, standard
XHTML or use the integrated
Format Helper Toolbar. All methods allow you to format text and insert links, images and many other items quickly and easily.
Edit1 - WikiMarkup
The
WikiMarkup is a particular set of prefixes and suffixes common to Wikis for formatting text and inserting items, such as links and images. In this section you'll learn how to use
WikiMarkup.
Edit1.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
Edit1.2 - Links
To create a link, place it in square brackets like this:
[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.xceed.com] produces http://www.xceed.com - You can link to an internal file or subdirectory:
[blog/|Blog] produces Blog and [GPL.txt|GPL] produces GPL
You can upload files using the
File Management interface. You can then link to them as described above.
Edit1.2.1 - Notes
Links and Images share the same general syntax, but the number of fields changes.
Samples
Edit1.2.2 - Page Attachments
You can
attach a file to a Page using the following syntax:
[attachment:File.jpg]
Attachments are listed at the bottom of the Page. The attached files are not real attachments, but rather links to some
uploaded files.
Edit1.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
Note: headings must be placed at the beginning of lines.
Edit1.3.1 - Horizontal Line
You can place a horizontal line using four hyphens
----.
Edit1.4 - Images
Images use
[ and ] as delimiters. 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 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
You can upload images and files using the
File Management interface.
Edit1.4.1 - Notes
Links and Images share the same general syntax, but the number of fields changes.
Edit1.5 - Lists
A list is made by a sequence of lines starting with one or more asterisks (
*) and/or sharp character
#). You can create nested list using more than one asterisk or sharp.
* 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
|
Edit1.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].
Edit1.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.
Edit1.8 - Special Tags
WPFwiki provides a few special markers that are replaced automatically with specific content. All these tags ignore the letter casing.
{wikititle} produces WPFwiki (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.0 (the version of the Wiki engine){mainurl} produces http://www.wpfwiki.com/ (the Main URL of the Wiki){pagecount} produces 121 (the # of Pages in the Wiki){username} inserts the Username of the current user{cloud} inserts a Categories Cloud{searchbox} inserts a Search Box (only one Search Box can be used at a time){clear} to use when inserting images at the bottom of a Page
Edit1.9 - Boxes
If you want to wrap some content inside a box, use triple brackets
((( and
))). For example,
(((My box))) produces
My box
Edit1.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
Edit1.11 - Tables
The
WikiMarkup also supports tables. Since the tables offer many options, they are described in the dedicated section
Tables. Here is an example of what can be done with tables:
Styled Table| This is a cell | This is a cell | This is a cell |
| Styled cell | Styled cell | Normal cell |
| Normal | Normal | Download |
Edit1.12 - User Signature
Users can sign their edits using four tildes (§). The result is the following: §§§§
Edit1.13 - Snippets and Page Transclusion
To use the special features called
Snippets and
Page Transclusion, please go to the dedicated pages:
Edit1.14 - 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.
Edit1.15 - XHTML Support and Escaping
You can use standard XHTML content. You can use any tag, except for the "script" tag.
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 tag escapes all the angular brackets, making them visible.
<esc><strong>Your tag</strong></esc>
produces
<strong>Your tag</strong>
Edit2 - Format Toolbar
In the editing page there is the toolbar shown in this picture:
 Format 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
- Page link: allows to insert a link to a Wiki Page using a menu
- File link: allows to insert a link to an uploaded file
- External: allows to insert a link to an external destination
- Image: allows to insert an image using a simple Image Browser
- 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
- Insert Snippet: allows to insert a Snippet using a menu
- 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
... tags - Comment: wraps/unwraps selected text with XHTML comment tags
- Escape: wraps/unwraps selected text with escape tags
Copyright notice: The content of this page is used with permission. It is not copyrighted by Xceed.