• FAQ(pukiwiki.org)(Japanese)
• Text Formatting Rule Abstract (also included as the last part of this page)
  • Text Formatting Rule? (now preparing. Please refer to pukiwiki.dev site: Text Formatting Rule.)
• Plugin Help?

What's PukiWiki??

Anyone can edit all of the pages*1 in the PukiWiki?. You move to the page you want to edit, and click "[ Edit ]" at the top of the page. Then you can see a textfield, in which you can edit the descriptions of page.
The edited content are formed by the FormatRule.

You can edit the page ForPractice? in any way as a rule. So we advise you to try and edit a page!

How to make a new page

If you write WikiName? that includes two capitalized letters and BracketName? enclosing [[]], the mark ? appears at the tail of the written text strings. If you click the mark, the new page and the editable textfield are created, and you can modify the page the same way you usually edit a page.

What's the string attached to Links, such as "(3m)"?

The string (3m) shows that the page was updated about 3 minites ago , (5h) means about 5 hours, and (8d) means about 8 days.

Is this different from a BBS?

Yes, a little. If you modify a page, the page cannot show who was the modifier. So you can write your name near your changes. -- Developer Team? ... like this.

Can someone remove all the descriptions in a page?

Yes! In WikiClone?, such as PukiWiki?, anyone can dirty, remove, and even ruin pages. PukiWiki?, however, can do periodical backups, so the bad attacks will be ineffective. It is possible to recover the attacked pages easily.

Could the browser cache and proxy cancel my modifications?

If another person is editing the page you are editing, what happens? It's OK. PukiWiki? checks the differences between the changes on the original page and your modifications, by comparing the date of the updated original page with the date of your updated page.

In the case of conflict, you should reload the page you have edited and try to edit it again.

FormatRule

Inline Elements

In the following table you can see how to use the inline text elements of PukiWiki?

Format example	Formatting code	Comment
Emphasised text	''Emphasised text''	Put the text between two single quotes.
Italic text	'''Italic text'''	Put the text between three single quotes.
Text with a break	Text with &br; a break
Text in font size 24	&size(24){Text in font size 24};
Purple text	&color(purple){Purple text};
Colored text	&color(#123456){Colored text};
Red text with yellow backbround	&color(red,yellow){Red text with yellow background};
Strikethrough text	%%Strikethrough text%%
*2	((This is the footnote's text))	This inserts a footnote with the given text at the bottom of the page.
www.example.com	&ref(http://www.example.com);	This inserts a reference.
	&aname(Anchor);	This inserts an invisible anchor for hyperlinking.
449	&counter;	This inserts a counter. What does it count, in fact?
2	&online;	What does this do, in fact?
&version;	&version;	I guess this inserts the current version number of PukiWiki? itself?
WikiName?	WikiName	This create a link to another pages on the same Pukiwiki site.
BracketName?	[[BracketName]]	This creates a link to another page on a same Pukiwiki site.
External link	[[External link:http://www.example.com]]	This creates links to pages on other web sites.
InterWikiLink:page name	[[InterWikiLink:page name]]	This creates a link to another Wiki, right?
Paragraph	~Paragraph
Inline text Inline text	Inline text&br;Inline text	&br; is replaced with a line break.
Inline text~ #plug-in	Inline text~ #plug-in	The ~, followed by a line break works as an escape character that disables the # character, which normally activates a plugin.

Block Elements

In what follows, examples for the block elements will be given.
First, you will see the example as it should be entered into PukiWiki?,and
next is the result you'll get.

Preformatted text

 Preformatted text. There is a space in front of this text.

Preformatted text. There is a space in front of this text. 

Headings

*Heading level 1**Heading level 2***Heading level 3

There are no examples of how the heading looks like here,
because they would disturb the structure of this document.
But take a look at the headings above and below to see how
it might look.

Paragraphs and the tilde as and escape character

~Paragraph~*This will not be displayed as a heading

Paragraph

*This will not be displayed as a heading

Line break escape example~#comment (disables first letter formatting rule, which is used to activate plug-ins.)

Line break escape example

#comment (disables first letter formatting rule, which is used to activate plug-ins.)

Quotes

>Quote Level 1>>Quote Level 2>>>Quote Level 3

Quote Level 1

Quote Level 2

Quote Level 3

Unordered lists

-Unordered list level 1--Unordered list level 2---Unordered list level 3

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

Ordered lists

+Ordered list level 1++Ordered list level 2+++Ordered list level 3

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

Definition lists

:Definition|Description

Definition

Description

Comments

A comment is hidden here: //Comment

A comment is hidden here:

Horizontal Rule

----

Table

Simple

|aaa|bbb|ccc||111|222|333|

Advanced

|RIGHT:100|CENTER:|SIZE(20)|c -------------- format definition line|~Header|Header2|Header3|h ----------------- header line|CENTER:lowspan|COLOR(red):bbb|ccc||~|222|COLOR(#ff0000):BGCOLOR(yellow):333||footer|>|CENTER:colspan|f ----------------- footer line

CSV Table

,aaa,bbb,ccc,111,222,333

Special entities :

Special entity	Code	Comments
	&heart;
©	©
®	®
™	™
²	²
³	³
	 	You may not be able to see it, but there is a non-breaking space in the first column. It prevents a line from being broken at that point.
	
	You can define any unicode character up to #32000 using this code. Please note that you need a font that supports the character, or you will not be able to see it.
世	世	You can use characters from all over the world!
♂	♂	It is a man's world.
☿	♀	But it would be nothing without a woman.
∞	∞	We could go on like this forever...
Ω	Ω	But here it must end.

Nesting Elements

Paragraph Element-Emphasize Element

~This is the paragraph, which is the parent element that contains emphasized text. ''This is the emphasized text, that is the child element of the paragraph element.''

This is the paragraph, which is the parent element that contains emphasized text.
This is the emphasized text, that is the child element of the paragraph element.

Quotation Element-List Element

Level[0]>Quotation Level[1]AAA~Quotation Level[1]BBB>>Quotation Level[2]AAA~Quotation Level[2]BBB>>>Quotation Level[3]-Child Element-List Level[1]|TABLE|ELEMENT|NEXT|to|the Inline|element|in a list|--Child Element-List Level[2]&br;Line Break in a Element---Child Element-List Level[3]--Child Element-List Level[2]---Child Element-List Level[3]<<Quotation Level[1]>>Quotation Level[2]<<Get out of the Quotation Level2 Element>>>Quotation Level[3]AAA>>>Quotation Level[3]BBB-Child Element-List Level[1]--Child Element-List Level[2]---Child Element-List Level[3]

Level[0]

Quotation Level[1]AAA

Quotation Level[1]BBB

Quotation Level[2]AAA

Quotation Level[2]BBB

Quotation Level[3]

• Child Element-List Level[1]

  TABLE

  ELEMENT

  NEXT

  to

  the Inline

  element

  in a list

  • Child Element-List Level[2]
    
    Line Break in a Element
    • Child Element-List Level[3]
  • Child Element-List Level[2]
    • Child Element-List Level[3]

Quotation Level[1]

Quotation Level[2]

Get out of the Quotation Level2 Element

Quotation Level[3]AAA

Quotation Level[3]BBB

• Child Element-List Level[1]
  • Child Element-List Level[2]
    • Child Element-List Level[3]

This section needs to be brushed up.