Text is basically displayed as you typed, but there are several special formatting rules. This page is a summary of most frequently used formatting rules.


Inline Elements

Text Decorations and Special Entities

Format exampleCodeComment
Emphasised text''Emphasised text''(two single quotes)
Italic text'''Italic text'''(three single quotes)
Strikethrough text%%Strikethrough text%%
Underlined text%%%Underlined text%%%
A line break is inserted
here.
A line break is inserted&br;here.Inserts a linebreak.
Font size 24&size(24){Font size 24};
Purple text&color(purple){Purple text};
Colored text&color(#123456){Colored text};
Yellow text in black&color(yellow,black){Yellow text in black};
*1((Footnote text))Footnote number is inserted inline.
Footnote text is inserted at the end of the page.
<i>Not Italic</i><i>Not Italic</i>HTML tags don't work.
[heart]& ©²&heart;&amp;&nbsp;&copy;&sup2;Character entity reference works.
"@☎漢字&#34;&#x40;&#x260e;&#28450;&#23383;Number entity reference works.
FormattingRules&page;Inserts the current page name.
&t;Inserts a horizontal tab.

References to Images and Files

Format exampleCodeComment
You can attach a file to a Wiki page by [Upload] command at the top of the page.
sample.jpg&ref(./sample.jpg);Inserts an image attached to the current page.
sample.jpg&ref(Page Name/sample.jpg);Inserts an image attached to another page.
sample.jpg&ref(http://www.example.com/sample.jpg);Inserts an external image.
filesample.zip&ref(./sample.zip);Inserts a download link if the target isn't an image.
sample.zip&ref(./sample.zip,noicon);Shows no download icon.
filesample.jpg&ref(./sample.jpg,noimg);Inserts a download link even if the target is an image.
sample.jpg&ref(./sample.jpg,nolink);Inserts no link for the original image.
sample.jpg&ref(./sample.jpg,60x40);Width x Height
sample.jpg&ref(./sample.jpg,50%);Zoom
This is a sample.&ref(./sample.jpg,This is a sample);Alternative text

Links

Format exampleCodeComment
WikiNameWikiNameWikiName is a string start with capital letter(s) + small letter(s) + capital letter(s) + small letter(s). WikiName can have no space. WikiName is always considered a Wiki page name and automatically linked to the Wiki page, or show a prompt ? to make a new page if the page doesn't exist.
Page Name[[Page Name]]BracketName is a page name enclosed between [[ and ]]. BracketName is considered a Wiki page name, as well as WikiName. A page name can contain spaces and have no restrictions for capitalization, but can't contain ", #, &, < and >.
Page Name#anchor[[Page Name#anchor]]You can include an anchor to a page name.
&aname(anchor);Inserts an anchor.
Headings automatically generate an anchor like [#vfad867b].
Alias[[Alias>Page Name]]Inserts a link to a Wiki page with an alias.
sample.jpg[[&ref(./sample.jpg);>Page Name]]Inserts a link to a Wiki page with an attached image.
sample.jpg[[http://www.example.com/sample.jpg>Page Name]]An external image can be used instead.
http://www.example.comhttp://www.example.comA url is automatically linked.
sample.jpghttp://www.example.com/sample.jpgA url to an image displays the image.
Site Name[[Site Name:http://www.example.com]]Inserts an external link with a text.
Page Name[[Page Name:<paste the url here>]]An easy way to link any heading of a PukiWiki page. Click at the heading and copy the url from browser's address window!
sample.jpg[[&ref(./sample.jpg);:http://www.example.com]]Inserts an external link with an attached image.

Block Elements

A block element continues until another block element or a blank line appears. There needs a blank line between two paragraphs, but if the next block isn't a paragraph (ie. starting with a special character), it's clear it's a new block and no blank line is necessary.

PukiWiki ignores any unnecessary blank lines, so you can insert some to make the source readable. Because more than one blank line insert no additional vertical space between block elements, you have to use &br; to insert more vertical space.

Paragraphs

A new line starts a paragraph, unless it starts with a special character like *, >, +, -, #, etc.

A new line starts with ~ explicitly starts a new paragraph. The letter ~ itself isn't shown and escapes the next special character including itself, if any.

Pressing Enter doesn't make a new line within a paragraph. To make a new line, insert ~ at the end of the line, or insert &br; anywhere in the line.

A new line starts with RIGHT: starts a new paragraph alined to right, and a new line starts with CENTER: starts a new paragraph alined to center.

Preformatted text

A new line starts with a space makes preformatted text. Preformatted text is displayed in a light blue box with a monospaced font. Line breaks aren't automatically inserted, and all formatting rules are ignored in preformatted text.

Example

This line starts with a space.

Headings

A new line starts with *, **, *** makes Heading level 1, 2, 3 respectively. In this page, the heading Block Elements is Heading level 1 and the heading Headings is Heading level 2.

Headings are also used in #contents plugin to make the table of contents.

Quotes

A new line starts with >, >>, >>> makes Quote level 1, 2, 3 respectively.

Example

Quote Level 1

Quote Level 2

Quote Level 3

lists

A new line starts with -, --, --- makes Unordered list level 1, 2, 3 respectively.

Example

  • Unordered list level 1
    • Unordered list level 2
      • Unordered list level 3

A new line starts with +, ++, +++ makes Ordered list level 1, 2, 3 respectively.

Example

  1. Ordered list level 1
    1. Ordered list level 2
      1. Ordered list level 3

A new line starts with :Definition|Description makes Difinition list. Any of difinition and description can be omitted.

Example

Definition 1
Description 1
Definition 2
Description 2

Comments

A new line starts with // is treated as a comment line and ignored.

Horizontal line

A new line starts with four dashes (----) or more inserts a horizontal line.

Example


Tables

Example 1

|aaa|bbb|ccc|
|111|222|333|
aaabbbccc
111222333


Example 2

|RIGHT:100|CENTER:|SIZE(20)|c -------------- format definition line
|~Header|Header2|Header3|h ----------------- header line
|CENTER:rowspan|COLOR(red):bbb|ccc|&br;|
|222|COLOR(#ff0000):BGCOLOR(yellow):333|
|footer|>|CENTER:colspan|f ----------------- footer line
HeaderHeader2Header3
footercolspan
rowspanbbbccc
222333

Plugins

Plugins are external commands for Puki Wiki, but most of plugins are installed as default. For example, &ref();, already explained in Inline Elements section, is one of plugins. Plugins with a name like &name; are inline elements and plugins with a name like #name are block elements. This is a list of some useful block element plugins.

CodeComment
#contentsGenerates the table of contents.
#ref(./sample.jpg)Block element version of &ref(); plugin. Accepts all options of &ref(); in addition to the following options.
#ref(./sample.jpg,left)Aligns the image left.
#ref(./sample.jpg,right)Aligns the image right.
#ref(./sample.jpg,wrap)Displays a border.
#ref(./sample.jpg,around)Allows text wraparound.
#clearClears text wraparound.
#noattachProhibits showing attached files at the end of the page. Often used to hide unnecessary download links when all attached files are image and not for download.
#commentAllows users to post comments.
#pcommentAllows users to post comments. Past log is stored to another page.
#vote(option1,option2,...)Allows users to vote.

*1 Footnote text

Front Page   New All Pages Search Recent Changes   Help   RSS of recent changes