FormatRule
[
Front page
] [
New
|
List of pages
|
Search
|
Recent changes
|
Help
]
Start:
*Text Formatting Rules [#te82f1fe]
Most text is displayed as it is written.
- HTML tags cannot be used. They are just displayed as te...
- Place an empty line after each paragraph. Lines without...
Use the formatting rules below to decorate texts. For the...
#contents
#hr
The input text of [[PukiWiki]] is usually shown in the sa...
**&aname(elements);Elements [#vec0ef3a]
First of all, let's describe the "world" of PukiWiki. Puk...
Example:
These two lines:
~This is a paragraph. It is the parent element which con...
''This is emphasized text, which is the child element of...
Will be formatted like this:
~This is a paragraph. It is the parent element which cont...
''This is emphasized text, which is the child element of ...
There are two kinds of elements in PukiWiki: "Block Eleme...
Block Elements, as the name suggests, consist of a whole ...
only consist of a part of a text block. In essence, the d...
-A Block Element:
--Can contain other Block and Inline Elements.
--Can be the Child Element of another Block Element.
-An Inline Element:
--Is always the Child Element of another Element.
--''Can'' contain other Inline Elements as its Child Elem...
--''Cannot'' contain other Block Elements as its Child El...
Next, we'll describe the two different kinds of elements ...
**&aname(block);Block Elements [#d2efdb6c]
-A Block Element can contain other Block Elements and Inl...
-As we said before, an empty line after a Block Element c...
-Block Elements can be Child Elements of other Block Elem...
--List and Quotation Elements can contain other Block Ele...
--List and Quotation have three levels of depth, which ar...
&br;&br;
But if you want to contain a List Element in another List...
&br;&br;
It may seem difficult explained like this, but it's proba...
-"<","<<",and "<<<" enable you to close a Quotation in a ...
--"<" lets you get out of the Quotation Level1 Element.
--"<<" lets you get out of the Quotation Level2 Element.
--"<<<" lets you get out of the Quotation Level3 Element.
-Empty Line closes not only the Quotation Element but als...
-# indicates the beginning of Plugin Block. (Plugin has 2...
***&aname(paragraph);Paragraph [#g3ebf1a7]
Inline Elements
PukiWiki assumes that each new Block is the beginning of ...
~Inline Elements
A line that starts with "~" indicates the beginning of a ...
-The first line of a Paragraph and a Paragraph in a Defin...
-Each Paragraph continues until the appearance of a new B...
-Paragraphs ''can'' be Child Elements of other Block Elem...
-Paragraphs ''cannot'' contain other Block Elements as it...
***&aname(quotation);Quotation [#j2411a69]
>Inline Element
A ">" character indicates the beginning of Quotation. Quo...
-A Quotation can contain other Block Elements as its Chil...
-As with all Block elements, a Quotation continues until ...
-A Paragraph in a Quotation continues until the beginning...
-Quotations can be Child Elements of Other Block Elements...
--When Quotation is a Child Element of another Quotation,...
--When Quotation is a Child Element of List, you don't ne...
-When Quotation contains List as its Child Element, you d...
-If you want to close a Quotation in a List, and keep the...
-"<","<<",and "<<<" enable you to close Quotation in List...
***&aname(lists);List [#adf32d50]
-Inline Element
At the beginning of a line,"-" indicates the beginning of...
-Unordered List may be contained by anoother Block Elemen...
-Increase the level by one when it is contained by other ...
-Unordered List may contain a Paragraph by writing "~" ri...
-Unordered List may contain another Block Element by writ...
+Inline Element
At the beginning of a line, "+" indicates the beginning o...
-Numbered List may be contained by another Block Elemnt.
-Increase the level by one when it is contained by other ...
-Numbered List may contain a Paragraph by writing "~" rig...
-Numbered List may contain another Block Element by writi...
:Item|Item's Definition
Definition List is a line starting with ":" and separated...
You may omit the Item or the Definition. You may give mul...
-Definition List must have "|" in the line.
-Item and Item's Definition must be an Inline Element.
-Definition List may be contained by another Block Element.
-Increase the indentation level by one when it is contain...
-Definition List may contain a Paragraph by writing "~" r...
-Definition List may contain other Block Elements by writ...
***&aname(preformed);Preformatted Texts [#x97a82ed]
"White Space" at the beginning of a line indicates the be...
//#br
-Preformatted Text can be the Child Element of other Bloc...
-Preformatted Text cannot contain other Block Elements as...
-Preformatted Text Elements will never be parsed by PukiW...
***&aname(table);Table [#we5546ee]
|Inline Element|Inline Element|
Inline Elements that are separated by "|", will be format...
-Incorrect
AAAA|BBB|CCC|DDD
-Correct
|AAA|BBB|CCC|DDD|
|AAA|BBB|CCC|DDD|
//#br
-The following codes can be used in conjunction with a ta...
LEFT:
CENTER:
RIGHT:
BGCOLOR(colorcode):
COLOR(colorcode):
SIZE(unit:px):
--These codes determine how and where Child Elements shou...
//#br
|Here is a Sample|regarding to the placements |of element...
|Flush Left|CENTER:Centered|RIGHT:Flush Right|
|RIGHT:Flush Right|Flush Left|CENTER:Centered|
|aaaaa|foot|aaaaa|f
|bbbb|bbbb|H E A D|h
|rowapn|BGCOLOR(blue):BLUE|COLOR(red):RED|
|~|>|colspan|
//#br
-"c" at the end of the line indicates the line to be Form...
LEFT:
CENTER:
RIGHT:
BGCOLOR(colorcode):
COLOR(colorcode):
SIZE(unit:px):
--By using these specific numbers, you can assign an exac...
-"h" at the end of the line indicates the line to be the ...
-"f" at the end of the line indicates the line to be the ...
-Cell containing Inline Element starting with "~" indicat...
-Cell containing only ">" will be concatenated with the C...
-Cell containing only "~" will be concatenated with the C...
//#br
-Table may be contained by another Block Element.
-As a general rule, a Table may not contain other Block E...
***&aname(csv);CSV Style Table [#b1645d3b]
,Inline Element,Inline Element,…
~Inline Elements that are separated by ","(comma), will b...
//#br
-You may enclose Inline Elements with Double Quotation ("...
-In the Inline Elements enclosed by Double Quotation ("),...
-Two consecutive Equal Signs (==) in the place of Inline ...
-More than one white space on the left of Inline Element ...
,aaaaaaaaa,bbbbbbb,ccccccc
,left , center , right
,==,COLOR(red):<-- colspan, test
//#br
-CSV Style Table may be contained by another Block Element.
-CSV Style Table may not contain other Block Elements.
***&aname(headline);Heading [#a191d5ac]
*Inline Element
A line that starts wit an "*" character becomes a Heading...
//#br
-Heading may not be contained by other Block Elements.
Heading closes other Block Elements.
-Heading may not contain other Block Elements.
***&aname(contents);Table of Contents [#be7ec652]
#contents
"#contents" at the beginning of the line creates Table of...
//#br
-Table of Contents should not be contained by other Block...
-Table of Contents may not contain other Block Elements.
***&aname(align);LEFT-CENTERED-RIGHT [#f3dbd6f2]
LEFT:Inline Element
CENTER:Inline Element
RIGHT:Inline Element
Writing "LEFT:", "CENTER:", or "RIGHT:" at the beginning ...
//#br
-All three Elements may be contained by other Block Eleme...
-All three Elements may not contain other Block Elements.
***&aname(horizon);Horizontal Rule[#a60a5ced]
----
Four or more "-" placed at the beginning of a line are sh...
-Horizontal Line may not be contained by other Block Elem...
-Horizontal Line may not contain other Block Elements.
***&aname(space);Line Break [#oa1708ba]
#br
"#br" placed at the beginning of a line makes a line brea...
//#br
-Line Break may not be contained by other Block Elements....
-Line Break may not contain other Block Elements.
***&aname(ref);Embedding Files and Images [#y1fe2c06]
#ref(file name)
#ref(URL of the file)
You can attach a file by writing #ref(file name) at the b...
You can place a hypertext link by writing #ref(URL of the...
If the file attached or linked is an image, the image is ...
//#br
-You can specify certain parameters by demarcating them w...
Page of the attachment file
--You can specify the page name of the attachment file. T...
--The following parameters can be specified immediately a...
-
left
center
right
--It specifies where to place the link or the image withi...
-
wrap
no wrap
--Specifies if the link or the image should be placed in ...
-
around
--Specifies if the text should wrap around the link or im...
--If you want to stop the wrapping, you can use "#img(,cl...
-
nolink
--Nolink overrides and eliminates the default linking to ...
-
Substitute Strings
--You can display a Substitute Strings instead of a file ...
--The Substitute Strings accept only String Inline Elemen...
--This option must be stated as the last parameter when y...
-#ref may be contained by other Block Elements.
-#ref may not accept other Block Element as a Child Eleme...
***&aname(clear);Disabling text wraparound [#w72effe8]
#clear
#clear placed at the beginning of the line cancels the te...
//#br
-#clear may not be contained by other Block Elements. Hor...
-#clear may not contain other Block Elements.
***&aname(form);Form [#v55d5a1f]
#comment
"#comment" at the beginning of the line embeds a form to ...
//#br
-#comment should not be contained by other Block Elements...
-#comment may not accept other Block Elments as Child Ele...
#pcomment
"#pcomment" at the beginning of the line embeds a form to...
//#br
-#pcomment should not be contained by other Block Element...
-#pcomment may not accept other Block Elements as Child E...
#article
"#article" at the beginning of the line embeds a simple f...
//#br
-#article should not be contained by other Block Elements...
-#article may not accept other Block Elements as Child El...
#vote(Option1,Option2,...)
"#vote" at the beginning of the line embeds a simple form...
//#br
-The options may contain string, WikiName, BracketName, I...
-#vote should not be contained by other Block Elements. A...
-#vote may not accept other Block Elements as Child Eleme...
**&aname(inline);Inline Elements [#t1de0d4e]
-Inline Element must be contained by a Block Element.
--If the parent Block Element is not explicitly specified...
--If the parent Block Element is explicitly specified at ...
-Inline Element may accept other Inline Elements as a Chi...
-Inline Elements follow the &foobar; format (user-def...
***&aname(string);Strings [#g6d1c119]
Strings
Strings are an Inline Element.
//#br
-Strings may be contained by other Inline Elements.
-Strings may not accept other Inline Elemnts as a Child E...
***&aname(linefeed);Line Breaks [#v1a2144b]
Inline Element~
Writing "~" at the end of the line inserts End of Line a ...
//#br
-End of Line voids any Block Element specified at the beg...
-End of Line may not be contained by other Inline Elements.
-End of Line may not accept other Inline Elements as a Ch...
-End of Line may not be used within the Item of Definitio...
&br;
Writing &br; breaks the line. Unlike "~" at the end o...
//#br
-Line Break may not be contained by other Inline Elements.
-Line Break may not accept other Inline Elements as a Chi...
***&aname(emphasis);Emphasis [#p46f371d]
''Inline Element''
Enclosing Inline Element with '' puts emphasis on...
//#br
-Emphasis (Bold) may be contained by other Inline Elements.
-Emphasis (Bold) may accept other Inline Elements as a Ch...
'''Inline Element'''
Enclosing Inline Element with ''' puts emphas...
//#br
-Emphasis (Italics) may be contained by other Inline Elem...
-Emphasis (Italics) may accept other Inline Elements as a...
***&aname(size);Font Size [#t6e5d501]
&size(Size){Inline Elements};
&size sets the size of inline elements in pixels (px).
//#br
-&size; may be contained by another inline elements.
-&size; may contain other inline elements.
***&aname(color);Font Color [#le009418]
&color(color){Inline Elements};
&color sets the color of inline elements.
//#br
-The color can be specified by one of the following:
--Color Code
--#rrggbb
--#rgb
-&color; may be contained by another inline elements.
-&color; may contain other inline elements.
***&aname(delete);Line Strikethrough [#zaf0da74]
%%Inline Elements%%
Inline elements enclosed with %% makes texts with...
//#br
-Line strikethrough may be contained by another inline el...
-Like strikethrough may contain other inline elements.
***&aname(note);Footnote [#o74286ea]
((Inline Elements))
Inline elements enclosed with (( and )) m...
//#br
-Footnote may be contained by another inline elements EXC...
-Footnote may contain other inline elements.
// 原文意味不明・・・
//-注釈は、他のインライン要素の子要素になることができます...
//-注釈は、他のインライン要素を子要素にすることができます...
// &p;
//&p; written inside a footnote breaks a paragraph. (...
//#br
//-Paragraph break inside a footnot must not be contained...
//-Paragraph break inside a footnot must not contain othe...
***&aname(ref2);Embedded Files and Images [#w04aa19e]
&ref(File Name);
&ref(URL);
&ref makes a link to an attachment file or a URL. If ...
//#br
-&ref can have the following parameters, separated by...
The page where the attachment file is uploaded.
--This parameter defines the page (WikiName、 BracketName...
--This parameter must be set right after the file name.
-
nolink
--By default &ref creates the link to the attachment ...
-
alternative string
--An alternative string is displayed instead of the file ...
--The string must not contain any inline elements other t...
--This parameter must be the last of all parameters.
-&ref; may be contained by another inline elements.
-&ref; must not contain other inline elements.
***&aname(ruby);Ruby [#c74c4c49]
&ruby(ruby string){Inline Elements};
&ruby makes a ruby (short runs of text alongside the ...
//#br
-Although any inline elements may become a ruby string, i...
-&ruby; may be contained by other inline elements.
-&ruby; may contain other inline elements.
-A ruby must not be nested.
-The use of a ruby should be avoided inside a footnote or...
***&aname(anchor);Anchor [#x9c38f18]
&aname(anchor name);
&aname(anchor name){Inline Elements};
&aname; makes an anchor for a link.
//#br
-The anchor name must be a string beginning with an alpha...
-The anchor name must not contain multi-byte characters, ...
-&anchor; may be contained by other inline elements.
-&anchor; may contain other inline elements.
***&aname(counter);Counter [#p695e822]
&counter;
&counter(options);
&counter; makes a counter that displays the number of...
//#br
-&counter; can have the following options. If no opti...
today
--Displays the number of accesses of today
-
yesterday
--Displays the number of accesses of yesterday
-
total
--Displays the total number of accesses
//#br
-&counter; may be contained by other inline elements.
-&counter; must not contain other inline elements.
***&aname(online);Online Viewers [#r8045aa7]
&online;
&online; displays the number of current accesses.
//#br
-&online; may be contained by other inline elements.
-&online; must not contain other inline elements.
***&aname(version);Version [#g4b02c96]
&version;
&version displays the version of PukiWiki.
//#br
-&version; may be contained by other inline elements.
-&version; must not contain other inline elements.
***&aname(wikiname);WikiName [#d89f7c04]
WikiName
[[WikiName]] stands for two or more Capitalized Words joi...
//#br
-WikiName cannot contain multi-byte character, spaces, sy...
-WikiName indicates a link to a page in Pukiwiki. If the ...
-WikiName can be a Child Element of other Inline Elements.
-WikiName cannot contain other Inline Elements as its Chi...
***&aname(bracketname);BracketName [#y97a88fc]
[[BracketName]]
A string enclosed with [[ and ]] makes [[...
//#br
-BracketName can contain multi-byte character, spaces, sy...
-BracketName cannot contain "#&<> .
-BracketName indicates a link to a page in Pukiwiki. If t...
-BracketName can be a Child Element of other Inline Eleme...
-BracketName cannot contain other Inline Elements as its ...
***&aname(interwiki);InterWiki [#ccc1aafb]
[[InterWikiName:PageName]]
By seperating a BracketName with : , you can create an [[...
//#br
-InterWikiName can contain muti-byte characters and spaces.
-InterWiki can be a Child Element of other Inline Elements.
-InterWiki cannot contain other Inline Elements as its Ch...
***&aname(link);Link [#w8e3c0dc]
[[Link Name:URL]]
By seperating a BracketName with : , you can creat a Link...
//#br
-Link Name can contain multi-byte characters and spaces i...
http://...
https://...
ftp://...
news://...
mailto:...
-You can also make a direct link by using the styles list...
-If an image is linked, it is shown on the page. (I'm laz...
//#br
-Link can be a Child Element of other Inline Elements.
-Link cannot contain other Inline Elements as its Child E...
***&aname(alias);Alias [#u896260b]
[[Alias>PageName]]
By seperating a BracketName with > , you can creat an Ali...
Alias enables you to make a link to a page in Pukiwiki wi...
You can also use an "anchor" to direct you to a certain p...
[[Alias>PageName#anchor]]
[[Alias>#anchor]]
//#br
-Alias can contain muti-byte characters and spaces.
-Relative link is available.
-Alias can be a Child Element of other Inline Elements.
-Alias can contain other Inline Elements as its Child Ele...
***&aname(entity);Entity [#ve8c2454]
-Entity is converted to a certain value when you submit a...
-Entity can be a Child Element of other Inline Elements.
-Entity cannot contain other Inline Elements as its Child...
****&aname(page);Page Name Entity [#b2f92a7e]
&page;
&page; is converted to the name of current editing pa...
//#br
-Page Name Entity is converted when the artile saved.
-Page Name Entity can be a Child Element of other Inline ...
-Page Name Entity cannot contain other Inline Elements as...
****&aname(date);Date Entity [#g57b899a]
&date;
&time;
&now;
&date; is converted to the current date.
&time; is converted to the current time.
&now; is converted to the current date and time.
//#br
- Date Entity is converted when the artile saved.
- Date Entity may not be contained by other Inline Elemen...
- Date Entity may not accept other Inline Elements as a C...
****&aname(refer_string);Character Entities[#m072caf3]
In addition to the character entities defined in SGML (e....
&heart;
&smile;
&bigsmile;
&huh;
&oh;
&wink;
&sad;
&worried;
-&heart; is displayed as: &heart;
-&smile; is displayed as: ⌣
-&bigsmile; is displayed as: &bigsmile;
-&huh; is displayed as: &huh;
-&oh; is displayed as: &oh;
-&wink; is displayed as: &wink;
-&sad; is displayed as: &sad;
-&worried; is displayed as: &worried;
-Character entities are converted when displayed.
-Character entities may be contained by other Inline Elem...
-Character entities may not accept other Inline Elements ...
****&aname(refer_numeral);Numeric Entity [#cdae2296]
&#Decimal-number;
&#xHexadecimal-number;
By writing a decimal number between &# and ; or a hex...
Take a look at the examples in the following table:
|''Special entity''|''Code''|''Comments''|h
|世|&#19990;|You can use characters from all ov...
|∞|&#8734;|We could go on like this forever...|
|Ω|&#937;|But here it must end.|
//#br
-Numeric Entity are converted when display.
-Numeric Entity may be contained by other Inline Elements.
-Numeric Entity may not accept other Inline Elements as a...
-Hexadecimal number must be written in small letter. (XHT...
**&aname(etc); Others [#ba8c703c]
***&aname(comment);Commnet line [#v455ee74]
// Comments
A line beginning with // is a comment. It is not displaye...
//#br
-The commnet line can be placed in any position.
-The commnet line doesn't affect other elements.
&br;
**Prohibition [#vc1bb6c0]
|LEFT:|CENTER:|CENTER:|c
|''Block Element''|''can contain other block elements''|'...
|''Paragraph''|CENTER:no|CENTER:yes|
|''Prefpmatted''|CENTER:no|CENTER:yes|
|''Headings''|CENTER:no|CENTER:no|
|''Table''|CENTER:no|CENTER:yes|
|''Table(CSV)''|CENTER:no|CENTER:yes|
|''List(unordered)''|CENTER:yes*|CENTER:yes|
|''List(ordered)''|CENTER:yes*|CENTER:yes|
|''Quote''|CENTER:yes*²|CENTER:yes|
|''Horizontal Line''|CENTER:no|CENTER:yes|
|''LEFT:/CENTER:/RIGHT:''|CENTER:no|CENTER:yes|
|''#ref''|CENTER:no|CENTER:yes|
|''#contents''|CENTER:no|CENTER:yes*³|
|''#comment''|CENTER:no|CENTER:yes*³|
|''#pcomment''|CENTER:no|CENTER:yes*³|
|''#article''|CENTER:no|CENTER:yes*³|
|''#vote(choice1,choice2,...)''|CENTER:no|CENTER:yes*&sup...
~* As long as the beginning of Child Element is Inline El...
you can insert a Block Element to the next line. (Please ...
~*²When Quotation is a Child Element of another Quot...
~*³ Due to pukiwiki's default setting of left margin...
&br;
**Compare Link Styles [#v3d91c05]
Here is a section to explain the differences between [[Wi...
***WikiName and BracketName [#nce9618f]
As you know by now, all of them are used in Pukiwiki to m...
And the difference betweem them is whether or not you can...
***InterWiki, Link, and Alias [#aae92bd2]
These styles are very similar, so they might be confusing...
First let's focus on their grammatical styles.
[[pukiwiki:Use PukiWiki]]..........[a]
[[whatever u like:http://pukiwiki.sourceforge.jp/?Use%20...
[[Another Name>Text Formatting Rule]]......[c]
[a] is an InterWiki styled link. And [b] is a Link styled...
Finaly, both of them will direct us the same page: http:/...
This is so, because pukiwi is defined in the InterWikiNam...
[http://pukiwiki.sourceforge.jp/? pukiwiki] utf8
Thus InterWiki combines two pieces of information. The fi...
InterWikiName is a kind of short cut. You can define any ...
For example, when you create an link to external/internal...
As you can see, [c] is a Alias styled link. You can use i...
In conclusion, the most important difference you need to ...
'' Which side is which?''
|Link Style|Left Side|Right Side|
|InterWiki|InterWikiName(Defined URL)|Additional URL|
|Link|Link text|Real URL|
|Alias|Link text|Real URL(WikiName/BracketName)|
&br;
**&aname(compare);Nesting Elements[#y4860837]
***Paragraph Element-Emphasize Element [#ned5fa77]
~This is the paragraph, which is the parent element that...
''This is the emphasized text that is the child element ...
~This is the paragraph, which is the parent element that ...
''This is the emphasized text that is the child element o...
***Quotation Element-List Element [#a0650018]
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|inline|element|in 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]
&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]
End:
*Text Formatting Rules [#te82f1fe]
Most text is displayed as it is written.
- HTML tags cannot be used. They are just displayed as te...
- Place an empty line after each paragraph. Lines without...
Use the formatting rules below to decorate texts. For the...
#contents
#hr
The input text of [[PukiWiki]] is usually shown in the sa...
**&aname(elements);Elements [#vec0ef3a]
First of all, let's describe the "world" of PukiWiki. Puk...
Example:
These two lines:
~This is a paragraph. It is the parent element which con...
''This is emphasized text, which is the child element of...
Will be formatted like this:
~This is a paragraph. It is the parent element which cont...
''This is emphasized text, which is the child element of ...
There are two kinds of elements in PukiWiki: "Block Eleme...
Block Elements, as the name suggests, consist of a whole ...
only consist of a part of a text block. In essence, the d...
-A Block Element:
--Can contain other Block and Inline Elements.
--Can be the Child Element of another Block Element.
-An Inline Element:
--Is always the Child Element of another Element.
--''Can'' contain other Inline Elements as its Child Elem...
--''Cannot'' contain other Block Elements as its Child El...
Next, we'll describe the two different kinds of elements ...
**&aname(block);Block Elements [#d2efdb6c]
-A Block Element can contain other Block Elements and Inl...
-As we said before, an empty line after a Block Element c...
-Block Elements can be Child Elements of other Block Elem...
--List and Quotation Elements can contain other Block Ele...
--List and Quotation have three levels of depth, which ar...
&br;&br;
But if you want to contain a List Element in another List...
&br;&br;
It may seem difficult explained like this, but it's proba...
-"<","<<",and "<<<" enable you to close a Quotation in a ...
--"<" lets you get out of the Quotation Level1 Element.
--"<<" lets you get out of the Quotation Level2 Element.
--"<<<" lets you get out of the Quotation Level3 Element.
-Empty Line closes not only the Quotation Element but als...
-# indicates the beginning of Plugin Block. (Plugin has 2...
***&aname(paragraph);Paragraph [#g3ebf1a7]
Inline Elements
PukiWiki assumes that each new Block is the beginning of ...
~Inline Elements
A line that starts with "~" indicates the beginning of a ...
-The first line of a Paragraph and a Paragraph in a Defin...
-Each Paragraph continues until the appearance of a new B...
-Paragraphs ''can'' be Child Elements of other Block Elem...
-Paragraphs ''cannot'' contain other Block Elements as it...
***&aname(quotation);Quotation [#j2411a69]
>Inline Element
A ">" character indicates the beginning of Quotation. Quo...
-A Quotation can contain other Block Elements as its Chil...
-As with all Block elements, a Quotation continues until ...
-A Paragraph in a Quotation continues until the beginning...
-Quotations can be Child Elements of Other Block Elements...
--When Quotation is a Child Element of another Quotation,...
--When Quotation is a Child Element of List, you don't ne...
-When Quotation contains List as its Child Element, you d...
-If you want to close a Quotation in a List, and keep the...
-"<","<<",and "<<<" enable you to close Quotation in List...
***&aname(lists);List [#adf32d50]
-Inline Element
At the beginning of a line,"-" indicates the beginning of...
-Unordered List may be contained by anoother Block Elemen...
-Increase the level by one when it is contained by other ...
-Unordered List may contain a Paragraph by writing "~" ri...
-Unordered List may contain another Block Element by writ...
+Inline Element
At the beginning of a line, "+" indicates the beginning o...
-Numbered List may be contained by another Block Elemnt.
-Increase the level by one when it is contained by other ...
-Numbered List may contain a Paragraph by writing "~" rig...
-Numbered List may contain another Block Element by writi...
:Item|Item's Definition
Definition List is a line starting with ":" and separated...
You may omit the Item or the Definition. You may give mul...
-Definition List must have "|" in the line.
-Item and Item's Definition must be an Inline Element.
-Definition List may be contained by another Block Element.
-Increase the indentation level by one when it is contain...
-Definition List may contain a Paragraph by writing "~" r...
-Definition List may contain other Block Elements by writ...
***&aname(preformed);Preformatted Texts [#x97a82ed]
"White Space" at the beginning of a line indicates the be...
//#br
-Preformatted Text can be the Child Element of other Bloc...
-Preformatted Text cannot contain other Block Elements as...
-Preformatted Text Elements will never be parsed by PukiW...
***&aname(table);Table [#we5546ee]
|Inline Element|Inline Element|
Inline Elements that are separated by "|", will be format...
-Incorrect
AAAA|BBB|CCC|DDD
-Correct
|AAA|BBB|CCC|DDD|
|AAA|BBB|CCC|DDD|
//#br
-The following codes can be used in conjunction with a ta...
LEFT:
CENTER:
RIGHT:
BGCOLOR(colorcode):
COLOR(colorcode):
SIZE(unit:px):
--These codes determine how and where Child Elements shou...
//#br
|Here is a Sample|regarding to the placements |of element...
|Flush Left|CENTER:Centered|RIGHT:Flush Right|
|RIGHT:Flush Right|Flush Left|CENTER:Centered|
|aaaaa|foot|aaaaa|f
|bbbb|bbbb|H E A D|h
|rowapn|BGCOLOR(blue):BLUE|COLOR(red):RED|
|~|>|colspan|
//#br
-"c" at the end of the line indicates the line to be Form...
LEFT:
CENTER:
RIGHT:
BGCOLOR(colorcode):
COLOR(colorcode):
SIZE(unit:px):
--By using these specific numbers, you can assign an exac...
-"h" at the end of the line indicates the line to be the ...
-"f" at the end of the line indicates the line to be the ...
-Cell containing Inline Element starting with "~" indicat...
-Cell containing only ">" will be concatenated with the C...
-Cell containing only "~" will be concatenated with the C...
//#br
-Table may be contained by another Block Element.
-As a general rule, a Table may not contain other Block E...
***&aname(csv);CSV Style Table [#b1645d3b]
,Inline Element,Inline Element,…
~Inline Elements that are separated by ","(comma), will b...
//#br
-You may enclose Inline Elements with Double Quotation ("...
-In the Inline Elements enclosed by Double Quotation ("),...
-Two consecutive Equal Signs (==) in the place of Inline ...
-More than one white space on the left of Inline Element ...
,aaaaaaaaa,bbbbbbb,ccccccc
,left , center , right
,==,COLOR(red):<-- colspan, test
//#br
-CSV Style Table may be contained by another Block Element.
-CSV Style Table may not contain other Block Elements.
***&aname(headline);Heading [#a191d5ac]
*Inline Element
A line that starts wit an "*" character becomes a Heading...
//#br
-Heading may not be contained by other Block Elements.
Heading closes other Block Elements.
-Heading may not contain other Block Elements.
***&aname(contents);Table of Contents [#be7ec652]
#contents
"#contents" at the beginning of the line creates Table of...
//#br
-Table of Contents should not be contained by other Block...
-Table of Contents may not contain other Block Elements.
***&aname(align);LEFT-CENTERED-RIGHT [#f3dbd6f2]
LEFT:Inline Element
CENTER:Inline Element
RIGHT:Inline Element
Writing "LEFT:", "CENTER:", or "RIGHT:" at the beginning ...
//#br
-All three Elements may be contained by other Block Eleme...
-All three Elements may not contain other Block Elements.
***&aname(horizon);Horizontal Rule[#a60a5ced]
----
Four or more "-" placed at the beginning of a line are sh...
-Horizontal Line may not be contained by other Block Elem...
-Horizontal Line may not contain other Block Elements.
***&aname(space);Line Break [#oa1708ba]
#br
"#br" placed at the beginning of a line makes a line brea...
//#br
-Line Break may not be contained by other Block Elements....
-Line Break may not contain other Block Elements.
***&aname(ref);Embedding Files and Images [#y1fe2c06]
#ref(file name)
#ref(URL of the file)
You can attach a file by writing #ref(file name) at the b...
You can place a hypertext link by writing #ref(URL of the...
If the file attached or linked is an image, the image is ...
//#br
-You can specify certain parameters by demarcating them w...
Page of the attachment file
--You can specify the page name of the attachment file. T...
--The following parameters can be specified immediately a...
-
left
center
right
--It specifies where to place the link or the image withi...
-
wrap
no wrap
--Specifies if the link or the image should be placed in ...
-
around
--Specifies if the text should wrap around the link or im...
--If you want to stop the wrapping, you can use "#img(,cl...
-
nolink
--Nolink overrides and eliminates the default linking to ...
-
Substitute Strings
--You can display a Substitute Strings instead of a file ...
--The Substitute Strings accept only String Inline Elemen...
--This option must be stated as the last parameter when y...
-#ref may be contained by other Block Elements.
-#ref may not accept other Block Element as a Child Eleme...
***&aname(clear);Disabling text wraparound [#w72effe8]
#clear
#clear placed at the beginning of the line cancels the te...
//#br
-#clear may not be contained by other Block Elements. Hor...
-#clear may not contain other Block Elements.
***&aname(form);Form [#v55d5a1f]
#comment
"#comment" at the beginning of the line embeds a form to ...
//#br
-#comment should not be contained by other Block Elements...
-#comment may not accept other Block Elments as Child Ele...
#pcomment
"#pcomment" at the beginning of the line embeds a form to...
//#br
-#pcomment should not be contained by other Block Element...
-#pcomment may not accept other Block Elements as Child E...
#article
"#article" at the beginning of the line embeds a simple f...
//#br
-#article should not be contained by other Block Elements...
-#article may not accept other Block Elements as Child El...
#vote(Option1,Option2,...)
"#vote" at the beginning of the line embeds a simple form...
//#br
-The options may contain string, WikiName, BracketName, I...
-#vote should not be contained by other Block Elements. A...
-#vote may not accept other Block Elements as Child Eleme...
**&aname(inline);Inline Elements [#t1de0d4e]
-Inline Element must be contained by a Block Element.
--If the parent Block Element is not explicitly specified...
--If the parent Block Element is explicitly specified at ...
-Inline Element may accept other Inline Elements as a Chi...
-Inline Elements follow the &foobar; format (user-def...
***&aname(string);Strings [#g6d1c119]
Strings
Strings are an Inline Element.
//#br
-Strings may be contained by other Inline Elements.
-Strings may not accept other Inline Elemnts as a Child E...
***&aname(linefeed);Line Breaks [#v1a2144b]
Inline Element~
Writing "~" at the end of the line inserts End of Line a ...
//#br
-End of Line voids any Block Element specified at the beg...
-End of Line may not be contained by other Inline Elements.
-End of Line may not accept other Inline Elements as a Ch...
-End of Line may not be used within the Item of Definitio...
&br;
Writing &br; breaks the line. Unlike "~" at the end o...
//#br
-Line Break may not be contained by other Inline Elements.
-Line Break may not accept other Inline Elements as a Chi...
***&aname(emphasis);Emphasis [#p46f371d]
''Inline Element''
Enclosing Inline Element with '' puts emphasis on...
//#br
-Emphasis (Bold) may be contained by other Inline Elements.
-Emphasis (Bold) may accept other Inline Elements as a Ch...
'''Inline Element'''
Enclosing Inline Element with ''' puts emphas...
//#br
-Emphasis (Italics) may be contained by other Inline Elem...
-Emphasis (Italics) may accept other Inline Elements as a...
***&aname(size);Font Size [#t6e5d501]
&size(Size){Inline Elements};
&size sets the size of inline elements in pixels (px).
//#br
-&size; may be contained by another inline elements.
-&size; may contain other inline elements.
***&aname(color);Font Color [#le009418]
&color(color){Inline Elements};
&color sets the color of inline elements.
//#br
-The color can be specified by one of the following:
--Color Code
--#rrggbb
--#rgb
-&color; may be contained by another inline elements.
-&color; may contain other inline elements.
***&aname(delete);Line Strikethrough [#zaf0da74]
%%Inline Elements%%
Inline elements enclosed with %% makes texts with...
//#br
-Line strikethrough may be contained by another inline el...
-Like strikethrough may contain other inline elements.
***&aname(note);Footnote [#o74286ea]
((Inline Elements))
Inline elements enclosed with (( and )) m...
//#br
-Footnote may be contained by another inline elements EXC...
-Footnote may contain other inline elements.
// 原文意味不明・・・
//-注釈は、他のインライン要素の子要素になることができます...
//-注釈は、他のインライン要素を子要素にすることができます...
// &p;
//&p; written inside a footnote breaks a paragraph. (...
//#br
//-Paragraph break inside a footnot must not be contained...
//-Paragraph break inside a footnot must not contain othe...
***&aname(ref2);Embedded Files and Images [#w04aa19e]
&ref(File Name);
&ref(URL);
&ref makes a link to an attachment file or a URL. If ...
//#br
-&ref can have the following parameters, separated by...
The page where the attachment file is uploaded.
--This parameter defines the page (WikiName、 BracketName...
--This parameter must be set right after the file name.
-
nolink
--By default &ref creates the link to the attachment ...
-
alternative string
--An alternative string is displayed instead of the file ...
--The string must not contain any inline elements other t...
--This parameter must be the last of all parameters.
-&ref; may be contained by another inline elements.
-&ref; must not contain other inline elements.
***&aname(ruby);Ruby [#c74c4c49]
&ruby(ruby string){Inline Elements};
&ruby makes a ruby (short runs of text alongside the ...
//#br
-Although any inline elements may become a ruby string, i...
-&ruby; may be contained by other inline elements.
-&ruby; may contain other inline elements.
-A ruby must not be nested.
-The use of a ruby should be avoided inside a footnote or...
***&aname(anchor);Anchor [#x9c38f18]
&aname(anchor name);
&aname(anchor name){Inline Elements};
&aname; makes an anchor for a link.
//#br
-The anchor name must be a string beginning with an alpha...
-The anchor name must not contain multi-byte characters, ...
-&anchor; may be contained by other inline elements.
-&anchor; may contain other inline elements.
***&aname(counter);Counter [#p695e822]
&counter;
&counter(options);
&counter; makes a counter that displays the number of...
//#br
-&counter; can have the following options. If no opti...
today
--Displays the number of accesses of today
-
yesterday
--Displays the number of accesses of yesterday
-
total
--Displays the total number of accesses
//#br
-&counter; may be contained by other inline elements.
-&counter; must not contain other inline elements.
***&aname(online);Online Viewers [#r8045aa7]
&online;
&online; displays the number of current accesses.
//#br
-&online; may be contained by other inline elements.
-&online; must not contain other inline elements.
***&aname(version);Version [#g4b02c96]
&version;
&version displays the version of PukiWiki.
//#br
-&version; may be contained by other inline elements.
-&version; must not contain other inline elements.
***&aname(wikiname);WikiName [#d89f7c04]
WikiName
[[WikiName]] stands for two or more Capitalized Words joi...
//#br
-WikiName cannot contain multi-byte character, spaces, sy...
-WikiName indicates a link to a page in Pukiwiki. If the ...
-WikiName can be a Child Element of other Inline Elements.
-WikiName cannot contain other Inline Elements as its Chi...
***&aname(bracketname);BracketName [#y97a88fc]
[[BracketName]]
A string enclosed with [[ and ]] makes [[...
//#br
-BracketName can contain multi-byte character, spaces, sy...
-BracketName cannot contain "#&<> .
-BracketName indicates a link to a page in Pukiwiki. If t...
-BracketName can be a Child Element of other Inline Eleme...
-BracketName cannot contain other Inline Elements as its ...
***&aname(interwiki);InterWiki [#ccc1aafb]
[[InterWikiName:PageName]]
By seperating a BracketName with : , you can create an [[...
//#br
-InterWikiName can contain muti-byte characters and spaces.
-InterWiki can be a Child Element of other Inline Elements.
-InterWiki cannot contain other Inline Elements as its Ch...
***&aname(link);Link [#w8e3c0dc]
[[Link Name:URL]]
By seperating a BracketName with : , you can creat a Link...
//#br
-Link Name can contain multi-byte characters and spaces i...
http://...
https://...
ftp://...
news://...
mailto:...
-You can also make a direct link by using the styles list...
-If an image is linked, it is shown on the page. (I'm laz...
//#br
-Link can be a Child Element of other Inline Elements.
-Link cannot contain other Inline Elements as its Child E...
***&aname(alias);Alias [#u896260b]
[[Alias>PageName]]
By seperating a BracketName with > , you can creat an Ali...
Alias enables you to make a link to a page in Pukiwiki wi...
You can also use an "anchor" to direct you to a certain p...
[[Alias>PageName#anchor]]
[[Alias>#anchor]]
//#br
-Alias can contain muti-byte characters and spaces.
-Relative link is available.
-Alias can be a Child Element of other Inline Elements.
-Alias can contain other Inline Elements as its Child Ele...
***&aname(entity);Entity [#ve8c2454]
-Entity is converted to a certain value when you submit a...
-Entity can be a Child Element of other Inline Elements.
-Entity cannot contain other Inline Elements as its Child...
****&aname(page);Page Name Entity [#b2f92a7e]
&page;
&page; is converted to the name of current editing pa...
//#br
-Page Name Entity is converted when the artile saved.
-Page Name Entity can be a Child Element of other Inline ...
-Page Name Entity cannot contain other Inline Elements as...
****&aname(date);Date Entity [#g57b899a]
&date;
&time;
&now;
&date; is converted to the current date.
&time; is converted to the current time.
&now; is converted to the current date and time.
//#br
- Date Entity is converted when the artile saved.
- Date Entity may not be contained by other Inline Elemen...
- Date Entity may not accept other Inline Elements as a C...
****&aname(refer_string);Character Entities[#m072caf3]
In addition to the character entities defined in SGML (e....
&heart;
&smile;
&bigsmile;
&huh;
&oh;
&wink;
&sad;
&worried;
-&heart; is displayed as: &heart;
-&smile; is displayed as: ⌣
-&bigsmile; is displayed as: &bigsmile;
-&huh; is displayed as: &huh;
-&oh; is displayed as: &oh;
-&wink; is displayed as: &wink;
-&sad; is displayed as: &sad;
-&worried; is displayed as: &worried;
-Character entities are converted when displayed.
-Character entities may be contained by other Inline Elem...
-Character entities may not accept other Inline Elements ...
****&aname(refer_numeral);Numeric Entity [#cdae2296]
&#Decimal-number;
&#xHexadecimal-number;
By writing a decimal number between &# and ; or a hex...
Take a look at the examples in the following table:
|''Special entity''|''Code''|''Comments''|h
|世|&#19990;|You can use characters from all ov...
|∞|&#8734;|We could go on like this forever...|
|Ω|&#937;|But here it must end.|
//#br
-Numeric Entity are converted when display.
-Numeric Entity may be contained by other Inline Elements.
-Numeric Entity may not accept other Inline Elements as a...
-Hexadecimal number must be written in small letter. (XHT...
**&aname(etc); Others [#ba8c703c]
***&aname(comment);Commnet line [#v455ee74]
// Comments
A line beginning with // is a comment. It is not displaye...
//#br
-The commnet line can be placed in any position.
-The commnet line doesn't affect other elements.
&br;
**Prohibition [#vc1bb6c0]
|LEFT:|CENTER:|CENTER:|c
|''Block Element''|''can contain other block elements''|'...
|''Paragraph''|CENTER:no|CENTER:yes|
|''Prefpmatted''|CENTER:no|CENTER:yes|
|''Headings''|CENTER:no|CENTER:no|
|''Table''|CENTER:no|CENTER:yes|
|''Table(CSV)''|CENTER:no|CENTER:yes|
|''List(unordered)''|CENTER:yes*|CENTER:yes|
|''List(ordered)''|CENTER:yes*|CENTER:yes|
|''Quote''|CENTER:yes*²|CENTER:yes|
|''Horizontal Line''|CENTER:no|CENTER:yes|
|''LEFT:/CENTER:/RIGHT:''|CENTER:no|CENTER:yes|
|''#ref''|CENTER:no|CENTER:yes|
|''#contents''|CENTER:no|CENTER:yes*³|
|''#comment''|CENTER:no|CENTER:yes*³|
|''#pcomment''|CENTER:no|CENTER:yes*³|
|''#article''|CENTER:no|CENTER:yes*³|
|''#vote(choice1,choice2,...)''|CENTER:no|CENTER:yes*&sup...
~* As long as the beginning of Child Element is Inline El...
you can insert a Block Element to the next line. (Please ...
~*²When Quotation is a Child Element of another Quot...
~*³ Due to pukiwiki's default setting of left margin...
&br;
**Compare Link Styles [#v3d91c05]
Here is a section to explain the differences between [[Wi...
***WikiName and BracketName [#nce9618f]
As you know by now, all of them are used in Pukiwiki to m...
And the difference betweem them is whether or not you can...
***InterWiki, Link, and Alias [#aae92bd2]
These styles are very similar, so they might be confusing...
First let's focus on their grammatical styles.
[[pukiwiki:Use PukiWiki]]..........[a]
[[whatever u like:http://pukiwiki.sourceforge.jp/?Use%20...
[[Another Name>Text Formatting Rule]]......[c]
[a] is an InterWiki styled link. And [b] is a Link styled...
Finaly, both of them will direct us the same page: http:/...
This is so, because pukiwi is defined in the InterWikiNam...
[http://pukiwiki.sourceforge.jp/? pukiwiki] utf8
Thus InterWiki combines two pieces of information. The fi...
InterWikiName is a kind of short cut. You can define any ...
For example, when you create an link to external/internal...
As you can see, [c] is a Alias styled link. You can use i...
In conclusion, the most important difference you need to ...
'' Which side is which?''
|Link Style|Left Side|Right Side|
|InterWiki|InterWikiName(Defined URL)|Additional URL|
|Link|Link text|Real URL|
|Alias|Link text|Real URL(WikiName/BracketName)|
&br;
**&aname(compare);Nesting Elements[#y4860837]
***Paragraph Element-Emphasize Element [#ned5fa77]
~This is the paragraph, which is the parent element that...
''This is the emphasized text that is the child element ...
~This is the paragraph, which is the parent element that ...
''This is the emphasized text that is the child element o...
***Quotation Element-List Element [#a0650018]
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|inline|element|in 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]
&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]
Page: