• The added line is THIS COLOR.
  • The deleted line is THIS COLOR.
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.
#contents
*Inline Elements [#rc591ee4]
**Text Decorations and Special Entities [#rd41ebad]
|''Format example''|''Code''|''Comment''|h
|''Emphasised text''|&color(red){''};Emphasised text&color(red){''};|(two single quotes)|
|'''Italic text'''|&color(red){'''};Italic text&color(red){'''};|(three single quotes)|
|%%Strikethrough text%%|&color(red){%%};Strikethrough text&color(red){%%};||
|%%%Underlined text%%%|&color(red){%%%};Underlined text&color(red){%%%};||
|A line break is inserted&br;here.|A line break is inserted&color(red){&br;};here.|Inserts a linebreak.|
|&size(24){Font size 24};|&color(red){&size(24){};Font size 24&color(red){}&#59;};||
|&color(purple){Purple text};|&color(red){&color(purple){};Purple text&color(red){}&#59;};||
|&color(#663466){Colored text};|&color(red){&color(#123456){};Colored text&color(red){}&#59;};||
|&color(yellow,black){Yellow text in black};|&color(red){&color(yellow,black){};Yellow text in black&color(red){}&#59;};||
|((Footnote text))|&color(red){((};Footnote text&color(red){))};|Footnote number is inserted inline.&br;Footnote text is inserted at the end of the page.|
|<i>Not Italic</i>|<i>Not Italic</i>|HTML tags don't work.|
|&heart;&amp;&nbsp;&copy;&sup2;|&color(red){&amp;heart;&amp;amp;&amp;nbsp;&amp;copy;&amp;sup2;};|Character entity reference works.|
|&#34;&#x40;&#x260e;&#28450;&#23383;|&color(red){&amp;#34;&amp;#x40;&amp;#x260e;&amp;#28450;&amp;#23383;};|Number entity reference works.|
|FormattingRules|&color(red){&amp;page;};|Inserts the current page name.|
|	|&color(red){&amp;t;};|Inserts a horizontal tab.|

** References to Images and Files [#l0c9c5ad]
** Embedding Images and Files [#l0c9c5ad]
|''Format example''|''Code''|''Comment''|h
|&ref(FormattingRules/sample.jpg);|&color(red){&amp;ref(};%%%./%%%sample.jpg&color(red){);};|Inserts an image attached to the current page.|
|&ref(FormattingRules/sample.jpg);|&color(red){&amp;ref(};%%%Page Name/%%%sample.jpg&color(red){);};|Inserts an image attached to another page.|
|&ref(FormattingRules/sample.jpg);|&color(red){&amp;ref(};%%%http:&#47;&#47;www.example.com/%%%sample.jpg&color(red){);};|Inserts an external image.|
|&ref(FormattingRules/sample.zip);|&color(red){&amp;ref(};%%%./%%%sample.zip&color(red){);};|Inserts a download link if the target isn't an image.|
|&ref(FormattingRules/sample.zip,noicon);|&color(red){&amp;ref(};%%%./%%%sample.zip&color(red){,noicon);};|Shows no download icon.|
|&ref(FormattingRules/sample.jpg,noimg);|&color(red){&amp;ref(};%%%./%%%sample.jpg&color(red){,noimg);};|Inserts a download link even if the target is an image.|
|&ref(FormattingRules/sample.jpg,nolink);|&color(red){&amp;ref(};%%%./%%%sample.jpg&color(red){,nolink);};|Inserts no link for the original image.|
|&ref(FormattingRules/sample.jpg,60x40);|&color(red){&amp;ref(};%%%./%%%sample.jpg&color(red){,60x40);};|Width x Height|
|&ref(FormattingRules/sample.jpg,50%);|&color(red){&amp;ref(};%%%./%%%sample.jpg&color(red){,50%);};|Zoom|
|&ref(FormattingRules/sample.jpg,This is a sample.);|&color(red){&amp;ref(};%%%./%%%sample.jpg&color(red){,This is a sample);};|Alternative text|
|>|>|CENTER:You can attach a file to a Wiki page by [Upload] command at the top of the page.|f

** Links [#i6016fe3]
|''Format example''|''Code''|''Comment''|h
|WikiName|&#87;ikiName|&#87;ikiName is a string start with ''capital letter(s) + small letter(s) + capital letter(s) + small letter(s)''. &#87;ikiName can contain no space. &#87;ikiName 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]]|&color(red){&#x5b;&#x5b;};Page Name&color(red){&#x5d;&#x5d;};|&#x42;racketName is a page name enclosed between ''&#91;['' and ''&#93;]''. &#x42;racketName is considered a Wiki page name, as well as &#87;ikiName. A page name can contain spaces and have no restrictions for capitalization, but can't contain ''"'', ''#'', ''&'', ''<'' and ''>''.|
|[[Page Name#anchor]]|&color(red){&#x5b;&#x5b;};Page Name%%%#anchor%%%&color(red){&#x5d;&#x5d;};|You can include an anchor to a page name.|
|&aname(anchor);|&color(red){&amp;aname(};anchor&color(red){);};|Inserts an anchor.&br;Headings automatically generate an anchor like [&#35;vfad867b].|
|[[Alias>Page Name]]|&color(red){&#91;&#91;};Alias&color(red){>};Page Name&color(red){]]};|Inserts a link to a Wiki page with an alias.|
|[[&ref(FormattingRules/sample.jpg);>Page Name]]|&color(red){&#91;&#91;&amp;ref(};%%%./%%%sample.jpg&color(red){);>};Page Name&color(red){]]};|Inserts a link to a Wiki page with an attached image.|
|[[&ref(FormattingRules/sample.jpg);>Page Name]]|&color(red){&#91;&#91;};%%%http:&#47;&#47;www.example.com/%%%sample.jpg&color(red){>};Page Name&color(red){]]};|An external image can be used instead.|
|http://www.example.com|%%%http:&#47;&#47;www.example.com%%%|A url is automatically linked.|
|&ref(FormattingRules/sample.jpg);|%%%http:&#47;&#47;www.example.com/%%%sample.jpg|A url to an image displays the image.|
|[[Site Name:http://www.example.com]]|&color(red){&#91;&#91;};Site Name&color(red){'':''};%%%http:&#47;&#47;www.example.com%%%&color(red){]]};|Inserts an external link with a text.|
|[[Page Name:http://miyoshino.la.coocan.jp/eswiki/?Page%20Name#o82778fb]]|&color(red){&#91;&#91;};Page Name&color(red){'':''};&color(green){<paste the url here>};&color(red){]]};|An easy way to link any heading of a PukiWiki page. Click &color(#a63d21){&dagger;}; at the heading and copy the url from browser's address window!|
|[[Page Name:http://miyoshino.la.coocan.jp/eswiki/?Page%20Name#o82778fb]]|&color(red){&#91;&#91;};Page Name&color(red){'':''};&color(green){<paste the url here>};&color(red){]]};|An easy way to link any heading of PukiWiki pages. Click &color(#a63d21){&dagger;}; at the heading and copy the url from browser's address window!|
|[[&ref(FormattingRules/sample.jpg);:http://www.example.com]]|&color(red){&#91;&#91;&amp;ref(};%%%./%%%sample.jpg&color(red){);'':''};%%%http:&#47;&#47;www.example.com%%%&color(red){]]};|Inserts an external link with an attached image.|

* Block Elements [#k3bbaf0c]
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 ''&amp;br;'' to insert more vertical space.

** Paragraphs [#i362391b]
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 &amp;br; anywhere in the line.
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 ''&amp;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 [#n759c266]
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 [#ac5978ad]
A new line starts with ''*'', ''**'', ''***'' makes Heading level 1, 2, 3 respectively. In this page, the heading [[Block Elements>FormattingRules#k3bbaf0c]] is Heading level 1 and the heading [[Headings>FormattingRules#ac5978ad]] is Heading level 2.

Headings are also used in [[#contents plugin>FormattingRules#q29a8693]] to make the table of contents.

** Quotes [#kca2e842]
A new line starts with ''>'', ''>>'', ''>>>'' makes Quote level 1, 2, 3 respectively. 

''Example''
>Quote Level 1
>>Quote Level 2
>>>Quote Level 3

** lists [#z49f05aa]
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''
+Ordered list level 1
++Ordered list level 2
+++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 [#s7e1dcef]
A new line starts with ''//'' is treated as a comment line and ignored.

** Horizontal line [#c38d5b8c]
A new line starts with four dashes (''----'') or more inserts a horizontal line.

''Example''
----

** Tables [#pca8d4bc]

''Example 1''
 |aaa|bbb|ccc|
 |111|222|333|
|aaa|bbb|ccc|
|111|222|333|
&br;

''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
|RIGHT:100|CENTER:|SIZE(20)|c
|~Header|Header2|Header3|h
|CENTER:rowspan|COLOR(red):bbb|ccc|
|~|222|COLOR(#ff0000):BGCOLOR(yellow):333|
|footer|>|CENTER:colspan|f

** Plugins [#q29a8693]
Plugins are external commands for Puki Wiki, but most of plugins are installed as default. For example, ''&amp;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.

|''Code''|''Comment''|h
|&color(red){&#35;contents};|Generates the table of contents.|
|&color(red){&#35;ref(};%%%./%%%sample.jpg&color(red){)};|Block element version of [[&amp;ref();>FormattingRules#l0c9c5ad]] plugin. Accepts all options of &amp;ref(); in addition to the following options.|
|&color(red){&#35;ref(};%%%./%%%sample.jpg&color(red){,left)};|Aligns the image left.|
|&color(red){&#35;ref(};%%%./%%%sample.jpg&color(red){,right)};|Aligns the image right.|
|&color(red){&#35;ref(};%%%./%%%sample.jpg&color(red){,wrap)};|Displays a border.|
|&color(red){&#35;ref(};%%%./%%%sample.jpg&color(red){,around)};|Allows text wraparound.|
|&color(red){&#35;clear};|Clears text wraparound.|
|&color(red){&#35;noattach};|Prohibits 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.|
|&color(red){&#35;comment};|Allows users to post comments.|
|&color(red){&#35;pcomment};|Allows users to post comments. Past log is stored to another page.|
|&color(red){&#35;vote(};option1,option2,...&color(red){)};|Allows users to vote.|


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