• View
• Edit
• History
• Print
• Backlinks

EFNExplained

=== READ THIS === READ THIS === READ THIS === If you wish to learn by actually editing the source you should check out PmWikiCreole/EFNByExample rather than this page. On that page elements used to produce the page are only those actually explained on the page. The page you are currently editing often uses other (more advanced) elements to make the display of the explanations more clear. === READ THIS === READ THIS === READ THIS ===

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.

This page presents elements 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)

Lists

Ordered lists

Start a line with one or more # marks:

# Item 1
# Item 2

This produces:

(:include EFNByExample#EFNLists1:)

Unordered lists

Start a line with one or more * marks:

* Item 1
* Item 2

This produces:

(:include EFNByExample#EFNLists2End:)

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:

(:include EFNByExample#EFNLists3End:)

Emphasis

Bold

Wrap text in 3 single quotes:

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

This produces:

(:include EFNByExample#EFNBold:)

Italics

Wrap text in 2 single quotes:

This text is ''in italics'' type.

This produces:

(:include EFNByExample#EFNItalicsEnd:)

Bold italics

Wrap text in 5 single quotes:

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

This produces:

(:include EFNByExample#EFNBoldItalics:)

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:

(:include EFNByExample#EFNHeadings:)

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:

(:include EFNByExample#EFNLinks1:)

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

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

This produces:

(:include EFNByExample#EFNLinks2:)

To change the text displayed:

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

(:include EFNByExample#EFNLinks3:)

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:

(:include EFNByExample#EFNLinks4:)

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:

(:include EFNByExample#EFNLinks5:)

To change the text displayed:

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

This produces:

(:include EFNByExample#EFNLinks6:)

Paragraphs

One or more blank lines make a paragraph:

This is a paragraph of text.

This is another paragraph.

This produces:

(:include EFNByExample#EFNParagraphs:)

Line breaks

End a line with \\:

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

This produces:

(:include EFNByExample#EFNLineBreaks:)

Preformatted text

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

[@
This text is preformatted.

@]

This produces:

(:include EFNByExample#EFNPreformatted:)

This text is preformatted.

To display text in a monospaced style:

This text is in @@monospaced@@ type.

This produces:

(:include EFNByExample#EFNMonoSpaced:)

Escape text

To display text in regular style while ignoring markup:

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

This produces:

(:include EFNByExample#EFNEscapedText:)

Images

Horizontal line

Start a line with 4 hyphens:

----

This produces:

(:include EFNByExample#EFNHorizontalLine:)

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:

(:include EFNByExample#EFNTable:)