• View
• Edit
• History
• Print
• Backlinks

EditingForNewcomers

For those new to wikis, or changing to PmWiki from another wiki, this is a good place to start. It describes a small set of text formatting rules that allow authors to create a wide range of page layout effects. The rules are based on the Creole standard. This standard recommends a basic wiki feature set that is simple yet powerful.

PmWiki is not WYSIWYG (what you see is what you get). Instead, authors edit the page text and add their content. You can do this by clicking the Edit link on the top right of most pages, or adding ?action=edit to the URL in the browser address bar.

To show what is possible with "newcomer markup" the page is made using only elements described on the page. It presents them in the order shown on all markup.

Overview

• Lists
• Emphasis
• Headings
• Links
• Paragraphs
• Line breaks
• Preformatted text
• Escape text
• Images
• Horizontal line
• Tables (defined on Creole's elements page but not on the all markup page)
• View the wiki source

Lists

Ordered lists

Start a line with one or more # marks:

# Item 1
# Item 2

This produces:

1. Item 1
2. Item 2

Unordered lists

Start a line with one or more * marks:

* Item 1
* Item 2

This produces:

• Item 1
• Item 2

Mixed lists

Lists can be nested and mixed:

* Item 1
** Sub-item 1.1
** Sub-item 2.1
* Item 2
## Sub-item 1.1
## Sub-item 2.1

This produces:

• Item 1
  • Sub-item 1.1
  • Sub-item 2.1
• Item 2
  1. Sub-item 1.1
  2. Sub-item 2.1

Emphasis

Bold

Wrap text in 3 single quotes:

This text is '''in bold''' type.

This produces:

This text is in bold type.

Italics

Wrap text in 2 single quotes:

This text is ''in italics'' type.

This produces:

This text is in italics type.

Bold italics

Wrap text in 5 single quotes:

This text is '''''bold italics''''' type. This text is ''italics and '''bold''''' type.

This produces:

This text is bold italics type. This text is italics and bold type.

Headings

Start a line with 1 or more ! marks:

! This is a top-level heading

!! This is a major heading

!!! This is a lesser heading

!!!! This is a minor heading

!!!! This is another minor heading

!!! This is another lesser heading

!!!! Followed by a minor heading

This produces:

This is a top-level heading

This is a major heading

This is a lesser heading

This is a minor heading

This is another minor heading

This is another lesser heading

Followed by a minor heading

Links

Internal links

PmWiki organises wiki pages onto groups: every page name consists of the group name followed by the name.

To link to a page in the current group, use its name:

[[recent changes]]

This produces:

recent changes

To link to a page in a different group, use its group and its name:

[[PmWiki.Basic editing]] or [[PmWiki/Basic editing]]

This produces:

PmWiki.Basic editing or Basic editing

To change the text displayed:

[[recent changes | history]] or [[PmWiki.Basic editing | editing wiki pages]]

history or editing wiki pages

Cross-reference links

To link to a place on the current page (such as a cross-reference to a heading):

[[#textAnchor]]
!!!!My topic

Cross-reference to [[#textAnchor | my topic]].

This produces:

My topic

Cross-reference to my topic.

The table of contents for this page was created using cross-reference links.

External links

To link to an external site:

http://www.example.com/ or [[http://www.example.com/]]

This produces:

http://www.example.com/ or http://www.example.com/

To change the text displayed:

[[http://www.example.com/ | this site]]

This produces:

this site

Paragraphs

One or more blank lines make a paragraph:

This is a paragraph of text.

This is another paragraph.

This produces:

This is a paragraph of text.

This is another paragraph.

Line breaks

End a line with \\:

This is the first line,\\
and this is the second line.

This produces:

This is the first line,
and this is the second line.

Preformatted text

Wrap a block of text in [@ ... @] markup:

[@
This text is preformatted.

@]

This produces:

This text is preformatted.

To display text in a monospaced style:

This text is in @@monospaced@@ type.

This produces:

This text is in monospaced type.

Escape text

To display text in regular style while ignoring markup:

This [=[[suppresses]] ''markup'' characters '''used'''.=]

This produces:

This [[suppresses]] ''markup'' characters '''used'''.

Images

Horizontal line

Start a line with 4 hyphens:

----

This produces:

---

Tables

To create a simple table:

||border=1
||row 1 cell 1 ||row 1 cell 2 ||
||row 2 cell 1 ||row 2 cell 2 ||

This produces:

row 1 cell 1	row 1 cell 2
row 2 cell 1	row 2 cell 2

View the wiki source

To see how the page is put together, view the wiki source. Then return to this page by pressing the browser's back button.