Markup

The markup listed is supplied by default in the distribution file. Additional markup could be available via plugins.

Paragraphs & general text flow

Paragraphs are created when 1 or more blank lines seperate text. Adjoinging lines will be concatenated together by default.

para 1 line 1. 
para 1 line 2. 
 
para 2 line 1. 
para 2 line 2.

para 1 line 1. para 1 line 2.

para 2 line 1. para 2 line 2.

You can force a newline by using either of the following markups

[[<<]] anywhere in the line
<-- at the end of a line
\\ (\\ and a space) anywhere in the line

Indented paragraphes can be created using a number of markups..

using -->. multiple '-' followed by '>' at the start of a line, ie -->indent or ------>indent more

indent style 1
using : :. multiple ':' followed by ' :' at the start of a line, ie :: :indent or :::: :indent more

indent style 2

Headings

Headings are created by starting a line with 1-6 ! characters.

 !heading level 1 
 !!!!heading level 4

Lists

Bulleted
- a * at the start of a line indicates a bullet item. By increasing the number of *, the list will be indented.

numbered
1. a # at the start of a line indicates a numbered item. By increasing the number of #, the list will be indented.

definition lists

Horizontal Line

Four or more dashes (----) at the start of a line will generate a horizontal line

Text Emphasis

Emphasis on text cannot be split accross lines, but can be used as many times as you like on a single line.

bold; ''' ''' around text (triple single-quotes)
italic '' '' around text (double single-quotes)
bold-italic ''''' ''''' around text (bold and italic markup)
bigger text [+ +] [+++ +] - The more + the bigger
smaller text [- -] [--- -] - The more - the smaller the text
monospaced @@ @@ around text
center contents of markup by surrounding with @! !@.
underline [_ _] around text
~~strike-through~~ [~ ~] around text
^superscript [^^ ^^] around text.
_subscript [__ __] around text (double underscore).
UPPERCASE [^ ^] around text translates text to upper case
lowercase.] [. .] around text translates text to [.lowercase
Unprinted comments are allowed within the text file. Anything surrounded by /* */ in the text file will not appear on the HTML page
Ignored [= =] around text. This will ignore any wiki processing on the text

Styles

Styles extend the display of text by adding colour, etc to be applied. The markup is to enclose the style name between two % %. One example is %red% which causes the remainder of the line to appear in red.

Tables

Tables can be applied by using the | (single pipe) character at the start and end of a line

 
|text        | text |  right|

|left aligned|centered|right aligned cell|

You can find a full description on the tables page

Variables

All variables are of the syntax {$xxx} where xxx is the variable name.

{$This} -
{$Engine} -
{$Version} - version of wiki engine
{$Release} - Release number of wiki engine
{$UrlPath} -
{$varname} - Substitute with contents of User variables (via Add-On script)

Page Commands

{{camelcase}} - Allow CamelCase linking, ie Two or more init-capped words joined together.
{{nocamelcase}} - Prevent CamelCase links
{{compactlist}} - Allow compact definition lists
{{nocompactlist}} - Prevent compact definition lists
{{include}} -
{{showchanges}} - plugin changehistory
{{index}} - plugin index
{{search}} - plugin search
{{sectionedit}} - plugin sectionediting
{{nosectionedit}} - plugin sectionediting
{{headerindent}} - plugin sectionediting
{{noheaderindent}} - plugin sectionediting
{{setskin}} - plugin skinning
{{useskin}} - plugin skinning
{{Style}} - plugin styles
{{toc}} - plugin toc
{{notoc}} - plugin toc
{{lastupd}} - plugin lastupd
{{var <varname>=<value>}} - Set variable.: User variables are simply used for text replacement. The advantage of this method is that repeated text can be placed in a variable and substituted via the $<varname>} syntax, without the requirement for editing the custom.php file. The contents of the variable are page specific.

Multi-line Markup

Most of the markup works for single lines only. There are of course reasons where this is not acceptable, ie pasting code, etc... WikiDX suppies a couple of markups that work over multiple lines. Both do not process any other markup contained within them.

[@ ... @] - Displays in a seperate <div>
[= ... =] - Displays as normal text.

Other..

[[#anchor]] - Creates anchor point in page. Can be accessed by adding #anchor to the URL or page link ie [[pagename#anchor]]
Comments ' (Single quote) at start of line. Text following will appear as smaller comment text

this is comment stuff

WikiDX

General