Wiki Formatting¶

Wiki markup is a core feature in DrProject, tightly integrating all
the other parts of DrProject into flexible and powerful whole.
DrProject's wiki engine implements an ever growing subset of the
commands from other popular wikis, especially [http://moin.sf.net/
MoinWiki].

This page demonstrates the formatting syntax available anywhere
WikiFormatting is allowed.

Font Styles¶

The DrProject wiki support the following font styles: 'bold', italic,
'bold italic', underline, ~_{strike-through}~, ^superscript, ``inline code``,
and ,,subscript,,

The [[DrProject]] wiki support the following font styles: _'bold_', _italic_,
__'bold italic__', __underline__, ~~strike-through~~, ^superscript^, ``inline code``, 
and ,,subscript,,

Heading¶

You can create heading by starting a line with one up to five '='
characters followed by a single space and the headline text. The line
should end with a space followed by the same number of '=' characters.

Example:¶

h1. Heading 
h2. Subheading 

Paragraphs¶

A new text paragraph is created whenever two blocks of text are
separated by one or more empty lines.

A forced line break can also be inserted like this:

Line 1[[BR]]Line 2

which displays:

Line 1BRLine 2

Text paragraphs can be indented by starting the lines with two or more spaces.

Lists¶

The wiki supports both ordered/numbered and unordered lists:

* Item 1
*** Item 1.1
* Item 2

 1. Item 1
   1. Item 1.1
 1. Item 2

displays:

• Item 1
  • Item 1.1
• Item 2

  1. Item 1
  1. Item 1.1
  1. Item 2

Preformatted Text¶

Block quotes, preformatted text, are suitable for source code
snippets, notes and examples. Use three curly braces wrapped around
the text to define a block quote. For example:

 <pre>
  def HelloWorld()
      print "Hello World" 
 </pre>

displays:

 def HelloWorld()
     print "Hello World" 

Tables¶

Simple tables can be created using double bars:

||Cell 1||Cell 2||Cell 3||
||Cell 4||Cell 5||Cell 6||

becomes:

	Cell 1		Cell 2		Cell 3
	Cell 4		Cell 5		Cell 6

Links¶

Hyperlinks are automatically created for WikiPageNames and
urls. !WikiPageLinks can be disabled by prepending an exclamation
mark, such as ``!WikiPageLink``.

Examples:

TitleIndex, http://www.third-bit.com/drproject/.

Links can be given a more descriptive title by writing the link
followed by a space and a title and all this inside two square
brackets:

* [http://www.third-bit.com Third Bit]
* [wiki:TitleIndex Title Index]

displays:

• [http://www.third-bit.com Third Bit]
• [wiki:TitleIndex Title Index]

DrProject Links¶

Wiki pages can link directly to other parts of the DrProject system.
Pages can refer to tickets, reports, changesets, milestones, source
files and other Wiki pages using the following notation:

	Tickets		'!#1' or '!ticket:1'
	Changesets		'![1]' or '!changeset:1'
	Wiki pages		'[[CamelCase]]' or '!wiki:CamelCase'
	Milestones		'!milestone:1.0'
	Files		'!source:trunk/COPYING'
	A specific file revision:		'!source:/trunk/COPYING#200'
	Mail messages		'!@1@' or '!mail:1'

See DrProjectLinks for more information.

Escaping Links and Wiki Names¶

You may avoid making hyperlinks out of DrProjectLinks by preceding an
expression with a single '!':

 !NoHyperLink
 !#42 is not a link

displays:

!NoHyperLink
 !#42 is not a link

Images¶

URLs ending with .png, .gif or .jpg are automatically interpreted as
image links, and converted to HTML image tags. For example:

http://www.third-bit.com/drproject/drproject-dev/chrome/drproject.jpg

displays:

http://www.third-bit.com/drproject/drproject-dev/chrome/drproject.jpg

Macros¶

Macros are used to insert dynamic content in a page. See WikiMacros
for usage:

 [[Timestamp]]

becomes:

[[Timestamp]]

Processors¶

DrProject supports alternative markup formats using WikiProcessors.
The most commonly used renders [wiki:WikiHtml HTML]:

Example 1¶

#!html
<pre class="wiki"><pre>
#!html
&lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt;
</pre></pre>

displays:

#!html
<h1 style="text-align: right; color: blue">HTML Test</h1>

Example 2¶

#!html
<pre class="wiki"><pre>
#!python
class Test:
    def __init__(self):
        print "Hello World" 
if __[[[[name]]]]__ == '__main__':
   Test()
</pre></pre>

displays:

#!python
class Test:
    def __init__(self):
        print "Hello World" 
if __[[[[name]]]]__ == '__main__':
   Test()

Miscellaneous¶

Four or more dashes will be replaced by a horizontal line (<HR>):

 ----

displays the bar shown below.

---

See also:

• DrProjectLinks
• DrProjectGuide
• WikiHtml
• WikiMacros
• WikiProcessors