Wiki Formatting Rules

1. Headings
2. List
3. Indentation
4. Definition mode
5. Pre-formatted mode
6. Links
6.1. Free links
6.2. Web link
7. Embeding figures
8. Section Auto-numbering
9. HTML Tag
10. Embed HTML directly
11. Horizontal line
12. Tables

Abstract

The rationale behind the concept of Wiki is to provide an open platform for ALL users to create/maintain a complex document. The contributors of the wiki equivallently share the right of creating/modifying the document. Many wiki engines (software platforms) provide useful functionalities to facilitate the maintenance of the document, two of the most important: a CVS (Concurrent Version Control) system and simple while efficient formating rules.

The source code of this wiki can be traced back all the way to Ward Cunningham's WikiWikiWeb, who is the initiator of Wiki. More directly, it was modified (by fangq) based on Andreas Bilger's TthWiki, Alex Schroeder's OddMuse Wiki and, essentially, Clifford Adams's UseModWiki. Therefore, most of the formating rules of this wiki are compatible with other popular wiki engines.

Format

1. Headings

code:
= H1 title =
== H2 title ==
=== H3 title ===
==== H4 title ====
===== H5 title =====
====== H6 title =======
notice the space before/after the text.
result:

H1 title

H2 title

H3 title

H4 title

H5 title
H6 title

2. List

Bulleted items

code:
*Point number 1 ...
*Point number 2 ...
**Firstly
**Secondly
*Point number 3 ...
result:
  • Point number 1 ...
  • Point number 2 ...
    • Firstly
    • Secondly
  • Point number 3 ...

Numbered list

code:
#Point number 1 ...
#Point number 2 ...
##Firstly
##Secondly
#Point number 3 ...
result:
  1. Point number 1 ...
  2. Point number 2 ...
    1. Firstly
    2. Secondly
  3. Point number 3 ...

3. Indentation

code:
:Part1
::Item1
::Item2
result:
Part1
Item1
Item2

4. Definition mode

code:
;Wiki:definition
;;Wiki:definition
;;;Wiki:definition
result:
Wiki
definition
Wiki
definition
Wiki
definition

5. Pre-formatted mode

code: (all lines start with space)
 typedef struct
 {
        int b7:1;
        int b6:1;
        int b5:1;
        int b4:1;
        int b3:1;
        int b2:1;
        int b1:1;
        int b0:1;
 } bits;
result:
 typedef struct
 {
        int b7:1;
        int b6:1;
        int b5:1;
        int b4:1;
        int b3:1;
        int b2:1;
        int b1:1;
        int b0:1;
 } bits;

6. Links

6.1. Free links

Freelinks are the entry points to other wiki pages. The name of any wiki page can contain letters, "_" and space, where the space is equivallent to "_". code:
[[PMI]],[[my first wikipage]],[[wiki_EN]]
result:PMI,my first wikipage,wiki EN。 You can also change the displayed text for a given wiki page, for example: code:
[[database|PMI Breast Imaging Database]]
result:PMI Breast Imaging Database

6.2. Web link

Links can not only jump to other wiki pages, but any other web resources using the notion of URL.
[http://nmr.mgh.harvard.edu/~fangq Qianqian's Research Homepage]
result: Qianqian's Research Homepage

If you only include a URL in the square bracket, you will get a reference, the face text of these references will be numbered starting from 1.

please refer to [http://wqy.sf.net/][http://bbs.dartmouth.edu/~fangq/blog/]
result:please refer to 12

Moreover, if you write URL directly in your text, leaving a space after, it will create a web link as well., for example: http://nmr.mgh.harvard.du .

7. Embeding figures

You can embed figures by directly writing the URL:
http://sitaphi.com/pmi/database/images/pmilab.png
result:

8. Section Auto-numbering

If you want to number different sections and sub-sections, like the way this document does, you need to insert a "#" between your section titles, for example
== # Chapter 1 =
=== # Section 1 =
==== # SubSection 1 =
Insert at where you want to put the table of content, mostly at the beginning of the document.

9. HTML Tag

This wiki supports several HTML tags, including pre(pre-formatted text), b(bold), i(illatic), and br(line break), for example:
pre-formatted text
boldillatic,one line:
another line.

10. Embed HTML directly

You can embed raw HTML code or even Style or Javascript into ur Wiki document, for example
< html >
<style>
.menutable
{width:100%;border-collapse:collapse;border: solid thin #CCCCCC;background-color: #EEEEEE;font-size:9pt;}
.menucellon{background-color: #333333;color:yellow;}
.menucelloff{background-color: #EEEEEE;}
</style>
<table class="menutable">
<tr><td class="menucelloff" onmouseover="this.className='menucellon'", onmouseout="this.className='menucelloff'"><a href="http://sitaphi.com/pmi/database/">menu item</a></td>
</tr>
</table>
< /html >
(notice, remove the spaces in < html > and < /html > tags)
results

11. Horizontal line

code:
------------
result:

12. Tables

code:
|| date  || subject number ||
|| 2005/2/3 ||72||
|| 2005/1/2 ||20||
result:
date subject number
2005/2/3 72
2005/1/2 20
Powered by Habitat