WikiFormattingRules
Warning: These wiki pages have not been edited in years and may well be out of date/inaccurate. We recommend that you use them as a starting point for further investigation, rather than gospel.
Level 1 Heading (H1)
= Level 1 Heading (H1) =
Level 2 Heading (H2)
== Level 2 Heading (H2) ==
Level 3 Heading (H3)
=== Level 3 Heading (H3) ===
Level 4 Heading (H4)
[ ==== Level 4 Heading (H4)
Level 5 Heading (H5)
===== Level 5 Heading (H5)
Level 6 Heading (H6)
====== Level 6 Heading (H6)
The horizontal lines in this page are made with 4 or more dashes:
----
Paragraphs are separated by a blank line.
Like this. Another paragraph.
Paragraphs are separated by a blank line.
Like this. Another paragraph.
Bold text, italic text, and underscore text.
*Bold text*, /italic text/, and _underscore text_.
Combination of bold and italics
/*Combination of bold and italics*/
Inline code like /etc/passwd or CGI::Kwiki
Inline code like [=/etc/passwd] or [=CGI::Kwiki]
WikiLinks are formed by two or more words in camel-case.
WikiLinks are formed by two or more words in /camel-case/.
External links begin with http://, like http://www.freepan.org
External links begin with http://, like http://www.freepan.org
Forced wiki [links] are a alphanumeric string surrounded by square brackets.
Forced wiki [links] are a alphanumeric string surrounded by square brackets.
Named http links have text with an http:// link inside, like FreePAN and Site
Named http links have text with an http:// link inside, like [FreePAN http://www.freepan.org Site]
Sometimes WordsShouldNotMakeAWikiLink so put a '!' beforehand.
Sometimes !WordsShouldNotMakeAWikiLink so put a '!' beforehand.
Same thing with http:/www.hayda.net - chat
Same thing with !http://foobar.com
Mailto links are just email addresses like foo@bar.com.
Mailto links are just email addresses like foo@bar.com.
----
Links to images display the image:
http://www.google.com/images/logo.gif
http://www.google.com/images/logo.gif
----
Unordered lists begin with a '* '. The number of asterisks determines the level:
* foo
* bar
** boom
** bam
* baz
* foo
* bar
** boom
** bam
* baz
----
Ordered lists begin with a '0 ' (zero):
0 foo
0 bar
00 boom
00 bam
0 baz
0 foo
0 bar
00 boom
00 bam
0 baz
----
You can mix lists too:
* Today:
00 Eat icecream
00 Buy a pony
* Tommorrow:
00 Eat more icecream
00 Buy another pony
* Today:
00 Eat icecream
00 Buy a pony
* Tommorrow:
00 Eat more icecream
00 Buy another pony
----
Any text that does not begin in the first column is rendered as preformatted text.
foo bar
x y
1 2
----
You can comment out wiki-text with '# ' at the beginning of a line. This will make the text an html comment:
# These lines have been
# commented out
# These lines have been
# commented out
----
Simple Tables:
| | Dick | Jane |
| height | 72" | 65" |
| weight | 130lbs | 150lbs |
| | Dick | Jane |
| height | 72" | 65" |
| weight | 130lbs | 150lbs |
----
Tables with multiline or complex data:
| <<END | <<END |
This data has vertical | bars |
END
# This is some Perl code:
sub foo {
print "I want a kwiki!\n"
}
END
| foo | <<MSG |
As you can see we use
the Perl heredoc syntax.
MSG
| <<END | <<END |
This data has vertical | bars |
END
# This is some Perl code:
sub foo {
print "I want a kwiki!\n"
}
END
| foo | <<MSG |
As you can see we use
the Perl heredoc syntax.
MSG
# Test
----
Changes from standard kwiki formatting:
* Forced wiki links in brackets must begin with a capital letter. e.g. [Thisisalink], [thisisnotalink].
* Text inside table cells is formatted. See kwiki's [http://kwiki.org/index.cgi?PatchFormatTableCells PatchFormatTableCells].