:CategoryDev/Document
PukiWiki/1.4/添付文書
../FormatRule

Japanese Version : PukiWiki/1.4/添付文書/FormattingRules


Text Formatting Rules

Most text is displayed as it is written.

  • HTML tags cannot be used. They are just displayed as texts (e.g., <font color="red">text</font>).
  • Place an empty line after each paragraph. Lines without an empty line between them are interpreted and displayed as a single paragraph.

Use the formatting rules below to decorate texts. For the formatting with plugins, only the most commonly used ones are explained here. See PukiWiki/1.4/Manual/Plugin for the details of the plugin options.


The input text of PukiWiki is usually shown in the same way as it was entered. However, you can use the following rules to enhance your texts. The use of HTML tags is forbidden. Instead, special characters can be used to format text. Formatting rules usually apply to a certain part of the text. Such a part of a text is called a text Element.

Elements

First of all, let's describe the "world" of PukiWiki. PukiWiki treats text as a set of Elements. An empty line indicates the end of an Element. Elements can contain other Elements. Such contained Elements are called "Child Elements". The element which contains "Child Elements" is called a "Parent Element".

Example: These two lines:

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

Will be formatted like this:

This is a paragraph. It is the parent element which contains an emphasized text element. This is emphasized text, which is the child element of the paragraph element.

There are two kinds of elements in PukiWiki: "Block Elements", and "Inline Elements". Block Elements, as the name suggests, consist of a whole block of text. Inline Elements only consist of a part of a text block. In essence, the difference between Block Elements and Inline Elements is as follows:

  • 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 Elements.
    • Cannot contain other Block Elements as its Child Elements.

Next, we'll describe the two different kinds of elements in detail.

Block Elements

  • A Block Element can contain other Block Elements and Inline Elements as its Child Elements. However, a Paragraph, a Heading, a Horizontal Line, and a #(Plugin[Block]) cannot contain other Block Elements as their Child Elements.
  • As we said before, an empty line after a Block Element closes all the Child Elements and Block Elements above at once.
  • Block Elements can be Child Elements of other Block Elements.
    • List and Quotation Elements can contain other Block Elements as their Child Elements. Block Elements in Child Elements inherit the indent level of its Parent Element. As always, an empty line ends the Block Element.
    • List and Quotation have three levels of depth, which are all independent. So, if you want to contain a List Element in a Quotation Element, or a Quotation Element in a List Element, you don't need to increase the indentation level of the Parent Element.

      But if you want to contain a List Element in another List Element, or Quotation in another Quotation as its Child Elements, you need to increase the indentation level of Parent Element.

      It may seem difficult explained like this, but it's probably more simple than it seems. Please check "Nesting Elements" for concrete examples.
  • "<","<<",and "<<<" enable you to close a Quotation in a Child Element without closing the Parent Element it belongs to.
    • "<" 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 also the Block Element it belongs to.
  • # indicates the beginning of Plugin Block. (Plugin has 2 modes:Block and Inline.)

Paragraph

Inline Elements

PukiWiki assumes that each new Block is the beginning of a new paragraph, unless you instruct it to format the text differently, by using the formatting codes of other Block Elements.

~Inline Elements

A line that starts with "~" indicates the beginning of a new paragraph. "~" also enables you escape the special characters (~、-、+、:、>、|、#、//) that are normally used as "Formatting Characters". Normally, these characters indicate the beginning of another kind of Element. Thus, the only way to put the special characters as a normal text at the beginning of a Paragraph is by putting a "~" in front of them.

  • The first line of a Paragraph and a Paragraph in a Definition List are indented. But neiher a List nor a Quotation are indented.
  • Each Paragraph continues until the appearance of a new Block Element.
  • Paragraphs can be Child Elements of other Block Elements.
  • Paragraphs cannot contain other Block Elements as its Child Elements.

Quotation

>Inline Element

A ">" character indicates the beginning of Quotation. Quotation has 3 indentation levels, indicated by: ">", ">>", and ">>>".

  • A Quotation can contain other Block Elements as its Child Elements.
  • As with all Block elements, a Quotation continues until the next empty line.
  • A Paragraph in a Quotation continues until the beginning of another Quotation or Block Element.
  • Quotations can be Child Elements of Other Block Elements. (Look at Nesting Elements for concrete examples.)
    • When Quotation is a Child Element of another Quotation, you need to increase the identation level by 1.
    • When Quotation is a Child Element of List, you don't need to increase the indentation level.
  • When Quotation contains List as its Child Element, you don't need to increase the level.
  • If you want to close a Quotation in a List, and keep the List Element opened, you have to start a Quotation Element with "<","<<","<<<" instead of ">",">>",">>>".
  • "<","<<",and "<<<" enable you to close Quotation in List without closing the List it belongs to.

List

-Inline Element

At the beginning of a line,"-" indicates the beginning of an Unordered List. Unordered lists have three levels, namely:"-", "--", and "---".

  • Unordered List may be contained by anoother Block Elements.
  • Increase the level by one when it is contained by other List. If it is contained by a Quotation, you do not have to increase the indentation level.
  • Unordered List may contain a Paragraph by writing "~" right after "-".
  • Unordered List may contain another Block Element by writing it in the next line as long as the beginning of Child Element is Inline Element or Paragraph.
    +Inline Element
    At the beginning of a line, "+" indicates the beginning of Numbered List. Numbered List has three levels namely:"+", "++", and "+++".
  • Numbered List may be contained by another Block Elemnt.
  • Increase the level by one when it is contained by other List. If it is contained by a Quotation, you do not have to increase the indentation level.
  • Numbered List may contain a Paragraph by writing "~" right after "+".
  • Numbered List may contain another Block Element by writing it in the next line as long as the beginning of Child Element is Inline Element or Paragraph.
:Item|Item's Definition

Definition List is a line starting with ":" and separated by "|" in the middle. There are three indentation levels for Definition List: ":", "::", and ":::".

You may omit the Item or the Definition. You may give multiple definitions to an item by writing a sequence of Definition List and omitting the Item after the first one.

  • 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 contained by other List. If it is contained by a Quotation, you do not have to increase the indentation level.
  • Definition List may contain a Paragraph by writing "~" right after "|".
  • Definition List may contain other Block Elements by writing a Block Element in the line right after the Definition List.

Preformatted Texts

"White Space" at the beginning of a line indicates the beginning of Preformatted Text. Line breaks are not automatically inserted in Preformatted Text.

  • Preformatted Text can be the Child Element of other Block Elements.
  • Preformatted Text cannot contain other Block Elements as its Child Element.
  • Preformatted Text Elements will never be parsed by PukiWiki. Thus its contents are displayed "as is".

Table

|Inline Element|Inline Element|

Inline Elements that are separated by "|", will be formatted as a Table. Remember that there needs to be a "|" character as well before the first Element of the table.

  • Incorrect
    AAAA|BBB|CCC|DDD
  • Correct
    |AAA|BBB|CCC|DDD|
AAABBBCCCDDD
  • The following codes can be used in conjunction with a table. They are placed at the beginning of the Child Element, and yield three posible text alignments.
    LEFT:
    CENTER:
    RIGHT:
    BGCOLOR(colorcode):
    COLOR(colorcode):
    SIZE(unit:px):
    • These codes determine how and where Child Elements should be displayed. The default setting is Left
      bbbbbbbbH E A D
      aaaaafootaaaaa
      Here is a Sampleregarding to the placementsof elements in each cell
      Flush LeftCenteredFlush Right
      Flush RightFlush LeftCentered
      rowapnBLUERED
      colspan
  • "c" at the end of the line indicates the line to be Formatting Row. The following code may be used in the Formatting Row.
    LEFT:
    CENTER:
    RIGHT:
    BGCOLOR(colorcode):
    COLOR(colorcode):
    SIZE(unit:px):
    • By using these specific numbers, you can assign an exact width (in px units) to a cell.
  • "h" at the end of the line indicates the line to be the Header Row (thead).
  • "f" at the end of the line indicates the line to be the Footer Row (tfood).
  • Cell containing Inline Element starting with "~" indicates the Cell to be a Header Cell (th).
  • Cell containing only ">" will be concatenated with the Cell right next to it (colspan).
  • Cell containing only "~" will be concatenated with the Cell above it (rowapn).
  • Table may be contained by another Block Element.
  • As a general rule, a Table may not contain other Block Element.

CSV Style Table

,Inline Element,Inline Element,…

Inline Elements that are separated by ","(comma), will be formatted as a Table. Note that you must write "," before the first Element of the CSV Style Table.

  • You may enclose Inline Elements with Double Quotation ("), which enables you to contain comma(,) in Inline Elements.
  • In the Inline Elements enclosed by Double Quotation ("), you may write two consecutive Double Quotations ("") to express Inline Element containing a Double Quotation (").
  • Two consecutive Equal Signs (==) in the place of Inline Element indicates colspan.
  • More than one white space on the left of Inline Element makes it right aligned; more than one white space on both right and left sides of Inline Element makes it center aligned.
aaaaaaaaabbbbbbbccccccc
leftcenterright
<-- colspantest
  • CSV Style Table may be contained by another Block Element.
  • CSV Style Table may not contain other Block Elements.

Heading

*Inline Element

A line that starts wit an "*" character becomes a Heading Element. There are three levels of heading Elements, namely: "*", "**",and "***".

  • Heading may not be contained by other Block Elements. Heading closes other Block Elements.
  • Heading may not contain other Block Elements.

Table of Contents

#contents

"#contents" at the beginning of the line creates Table of Contents based on the Headings. Generally, "#contents" are written on the top part of the page.

  • Table of Contents should not be contained by other Block Elements. Although Table of Contents may be contained by other Block Elements, left margin is set, assuing it is placed at the top-level.
  • Table of Contents may not contain other Block Elements.

LEFT-CENTERED-RIGHT

LEFT:Inline Element
CENTER:Inline Element
RIGHT:Inline Element

Writing "LEFT:", "CENTER:", or "RIGHT:" at the beginning of the line aligns the Inline Element.

  • All three Elements may be contained by other Block Elements.
  • All three Elements may not contain other Block Elements.

Horizontal Rule

----

Four or more "-" placed at the beginning of a line are shown as a horizontal rule.

  • Horizontal Line may not be contained by other Block Elements. Horizontal Line terminates other Block Elements.
  • Horizontal Line may not contain other Block Elements.

Line Break

#br

"#br" placed at the beginning of a line makes a line break in a block element or between block elements. *1

  • Line Break may not be contained by other Block Elements. Horizontal Line terminates other Block Elements.
  • Line Break may not contain other Block Elements.

Embedding Files and Images

#ref(file name)
#ref(URL of the file)

You can attach a file by writing #ref(file name) at the beginning of a line. You can place a hypertext link by writing #ref(URL of the file) at the beginning of a line. If the file attached or linked is an image, the image is displayed.

  • You can specify certain parameters by demarcating them with commas. When unspecified, the default values are used.
    Page of the attachment file
    • You can specify the page name of the attachment file. The name may be in WikiName or BracketName. When unspecified, the current page serves as the default.
    • The following parameters can be specified immediately after the page name.
    left
    center
    right
    • It specifies where to place the link or the image within the page. Center is the default.
    wrap
    no wrap
    • Specifies if the link or the image should be placed in a box. The default is to use no box.
    around
    • Specifies if the text should wrap around the link or image. No wrapping by default.
    • If you want to stop the wrapping, you can use "#img(,clear)".
    nolink
    • Nolink overrides and eliminates the default linking to the attached file.
    Substitute Strings
    • You can display a Substitute Strings instead of a file name and images. When unspecified, the file name is used by default.
    • The Substitute Strings accept only String Inline Elements. WikiName, BracketName, and other things will be interpreted as a String.
    • This option must be stated as the last parameter when you use this option.
  • #ref may be contained by other Block Elements.
  • #ref may not accept other Block Element as a Child Element.

Disabling text wraparound

#clear 

#clear placed at the beginning of the line cancels the text wraparound set in #ref. Wraparound is always cancelled at the end of the texts even without #clear.

  • #clear may not be contained by other Block Elements. Horizontal Line terminates other Block Elements.
  • #clear may not contain other Block Elements.

Form

#comment

"#comment" at the beginning of the line embeds a form to post comments.

  • #comment should not be contained by other Block Elements. Although #comment may be contained by other Block Elements, left margin is set, assuing it is placed at the top-level.
  • #comment may not accept other Block Elments as Child Element.
#pcomment

"#pcomment" at the beginning of the line embeds a form to post comments. Unlike "#comment", posted comments are recorded on a seperate page. Also, responses to a comment is displayed as tree structure.

  • #pcomment should not be contained by other Block Elements. Although #pcomment may be contained by other Block Elements, left margin is set, assuing it is placed at the top-level.
  • #pcomment may not accept other Block Elements as Child Element.
#article

"#article" at the beginning of the line embeds a simple forum.

  • #article should not be contained by other Block Elements. Although #article may be contained by other Block Elements, left margin is set, assuing it is placed at the top-level.
  • #article may not accept other Block Elements as Child Element.
#vote(Option1,Option2,...)

"#vote" at the beginning of the line embeds a simple form for voting.

  • The options may contain string, WikiName, BracketName, InterWiki, and link. Other Inline Elements may not be included as an option.
  • #vote should not be contained by other Block Elements. Although #vote may be contained by other Block Elements, left margin is set, assuing it is placed at the top-level.
  • #vote may not accept other Block Elements as Child Element.

Inline Elements

  • Inline Element must be contained by a Block Element.
    • If the parent Block Element is not explicitly specified at the beginning of the line, Inline Elements is silently contained by a Paragraph.
    • If the parent Block Element is explicitly specified at the beginning of the line, Inline Elements is contained by the Block Element.
  • Inline Element may accept other Inline Elements as a Child Element.
  • Inline Elements follow the &foobar; format (user-defined format).

Strings

Strings

Strings are an Inline Element.

  • Strings may be contained by other Inline Elements.
  • Strings may not accept other Inline Elemnts as a Child Element.

Line Breaks

Inline Element~

Writing "~" at the end of the line inserts End of Line a line break. End of Line is a line break within a Block Element.

  • End of Line voids any Block Element specified at the beginning of the next line, and turns it into a String.
  • End of Line may not be contained by other Inline Elements.
  • End of Line may not accept other Inline Elements as a Child Element.
  • End of Line may not be used within the Item of Definition List, Item of a Table, or in the parameter of Block Elements starting with "#".
&br;

Writing &br; breaks the line. Unlike "~" at the end of the line, Line Break may be used within the Item of Definition List, Item of a Table, or in the parameter of Block Elements starting with "#".

  • Line Break may not be contained by other Inline Elements.
  • Line Break may not accept other Inline Elements as a Child Element.

Emphasis

''Inline Element''

Enclosing Inline Element with '' puts emphasis on the element (Bold font).

  • Emphasis (Bold) may be contained by other Inline Elements.
  • Emphasis (Bold) may accept other Inline Elements as a Child Element.
'''Inline Element'''

Enclosing Inline Element with ''' puts emphasis on the element (Italics).

  • Emphasis (Italics) may be contained by other Inline Elements.
  • Emphasis (Italics) may accept other Inline Elements as a Child Element.

Font Size

&size(Size){Inline Elements};

&size sets the size of inline elements in pixels (px).

  • &size; may be contained by another inline elements.
  • &size; may contain other inline elements.

Font Color

&color(color){Inline Elements};

&color sets the color of inline elements.

  • 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.

Line Strikethrough

%%Inline Elements%%

Inline elements enclosed with %% makes texts with strikethrough.

  • Line strikethrough may be contained by another inline elements.
  • Like strikethrough may contain other inline elements.

Footnote

((Inline Elements))

Inline elements enclosed with (( and )) makes a footnote. A link to the footnote is created in the text. Footnotes cannot be nested.

  • Footnote may be contained by another inline elements EXCEPT another footnote.
  • Footnote may contain other inline elements.

Embedded Files and Images

&ref(File Name);
&ref(URL);

&ref makes a link to an attachment file or a URL. If the attachment is an image file, the image is displayed.

  • &ref can have the following parameters, separated by cammas. Default values are used for unspecified parameters.
    The page where the attachment file is uploaded.
    • This parameter defines the page (WikiName、 BracketName) where the attachment file is stored. The default is the current page.
    • This parameter must be set right after the file name.
    nolink
    • By default &ref creates the link to the attachment file. With nolink, the link is not created.
    alternative string
    • An alternative string is displayed instead of the file name. By default, the file name is displayed.
    • The string must not contain any inline elements other than a simple string. WikiName, BracketName, or other inline elements are all treated as a simple string.
    • This parameter must be the last of all parameters.
  • &ref; may be contained by another inline elements.
  • &ref; must not contain other inline elements.

Ruby

&ruby(ruby string){Inline Elements};

&ruby makes a ruby (short runs of text alongside the base text) for inline elements. In a browser does not support a ruby, it is displayed as texts surrounded by ( ).

  • Although any inline elements may become a ruby string, it may not be displayed as expected.
  • &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 in other places with small text size.

Anchor

&aname(anchor name);
&aname(anchor name){Inline Elements};

&aname; makes an anchor for a link.

  • The anchor name must be a string beginning with an alphabet and consisting of alphabets, digits, hiphens, and underscores.
  • The anchor name must not contain multi-byte characters, spaces, or other symbol characters.
  • &anchor; may be contained by other inline elements.
  • &anchor; may contain other inline elements.

Counter

&counter;
&counter(options);

&counter; makes a counter that displays the number of accesses to the page.

  • &counter; can have the following options. If no options are provided, "total" is used by default.
    today
    • Displays the number of accesses of today
    yesterday
    • Displays the number of accesses of yesterday
    total
    • Displays the total number of accesses
  • &counter; may be contained by other inline elements.
  • &counter; must not contain other inline elements.

Online Viewers

&online;

&online; displays the number of current accesses.

  • &online; may be contained by other inline elements.
  • &online; must not contain other inline elements.

Version

&version;

&version displays the version of PukiWiki.

  • &version; may be contained by other inline elements.
  • &version; must not contain other inline elements.

WikiName

WikiName

WikiName stands for two or more Capitalized Words joined together without spaces, muti-byte characters, symbols, and numbers.

  • WikiName cannot contain multi-byte character, spaces, symbols, or numbers.
  • WikiName indicates a link to a page in Pukiwiki. If the page already exists, the link is automatically made. And if it doesn't exist, the WikiName will have a ? mark behind it, which will be linked to to a page where you can add new contents for that name.
  • WikiName can be a Child Element of other Inline Elements.
  • WikiName cannot contain other Inline Elements as its Child Elements.

BracketName

[[BracketName]]

A string enclosed with [[ and ]] makes BracketName, which is another link style in Pukiwiki.

  • BracketName can contain multi-byte character, spaces, symbols, and numbers.
  • BracketName cannot contain "#&<> .
  • BracketName indicates a link to a page in Pukiwiki. If the page already exists, the link is automatically made. And if it doesn't exist, the BracketName will have a ? mark behind it, which will be linked to to a page where you can add new contents for that name.
  • BracketName can be a Child Element of other Inline Elements.
  • BracketName cannot contain other Inline Elements as its Child Elements.

InterWiki

[[InterWikiName:PageName]]

By seperating a BracketName with : , you can create an InterWiki block, which is another link style in Pukiwiki. The former part must contain an InterWikiName which is defined at InterWikiName which contains a list of defined InterWikiName. (What does this mean? It's not very clear.) The latter part must contain a WikiName or a BracketName without [[ and ]].

  • 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 Child Elements.

Link

[[Link Name:URL]]

By seperating a BracketName with : , you can creat a Link block, which is yet another link style in Pukiwiki. The former part can contain a certain string which is used for the displayed name of a link. The latter part must contain a URL.

  • Link Name can contain multi-byte characters and spaces in addition to alphabets, digits and a number of symbols.
http://...
https://...
ftp://...
news://...
mailto:...
  • You can also make a direct link by using the styles listed above.
  • If an image is linked, it is shown on the page. (I'm lazy. Please write the ideal way, to insert a link for image if you already know how. --- Olorin)
  • Link can be a Child Element of other Inline Elements.
  • Link cannot contain other Inline Elements as its Child Elements.

Alias

[[Alias>PageName]]

By seperating a BracketName with > , you can creat an Alias, which is another link style in Pukiwiki. The former part can contain a certain string which is used for a name of a link. The latter part must contain a WikiName or a BracketName styled string without [[ and ]].

Alias enables you to make a link to a page in Pukiwiki with a different name.

You can also use an "anchor" to direct you to a certain part of a page. When you use an anchor as an internal link, you can omit a PageName.:|

[[Alias>PageName#anchor]]
[[Alias>#anchor]]
  • 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 Elements.

Entity

  • Entity is converted to a certain value when you submit a page.
  • Entity can be a Child Element of other Inline Elements.
  • Entity cannot contain other Inline Elements as its Child Elements.

*Page Name Entity

&page;

&page; is converted to the name of current editing page.

  • Page Name Entity is converted when the artile saved.
  • Page Name Entity can be a Child Element of other Inline Elements.
  • Page Name Entity cannot contain other Inline Elements as its Child Elements.

*Date Entity

&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.

  • Date Entity is converted when the artile saved.
  • Date Entity may not be contained by other Inline Elements.
  • Date Entity may not accept other Inline Elements as a Child Element.

*Character Entities

In addition to the character entities defined in SGML (e.g., &copy;, &reg;, etc.), the following entities can be used.

&#38;heart;
&#38;smile;
&#38;bigsmile;
&#38;huh;
&#38;oh;
&#38;wink;
&#38;sad;
&#38;worried;
  • &heart; is displayed as: (heart)
  • &smile; is displayed as: :)
  • &bigsmile; is displayed as: :D
  • &huh; is displayed as: :p
  • &oh; is displayed as: :D
  • &wink; is displayed as: ;)
  • &sad; is displayed as: (
  • &worried; is displayed as: (^^;
  • Character entities are converted when displayed.
  • Character entities may be contained by other Inline Elements.
  • Character entities may not accept other Inline Elements as a Child Element.

*Numeric Entity

&#Decimal-number;
&#xHexadecimal-number;

By writing a decimal number between &# and ; or a hexadecimal number between &#x and ;, a Unicode character can be displayed. You may use this inline element to insert characters which you cannot directly type with your keyboard.

Take a look at the examples in the following table:

Special entityCodeComments
&#19990;You can use characters from all over the world!
&#8734;We could go on like this forever...
Ω&#937;But here it must end.
  • 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 Child Element.
  • Hexadecimal number must be written in small letter. (XHTML 1.0 rev 2 or newer allows only small letters.)

Others

Commnet line

// Comments

A line beginning with // is a comment. It is not displayed on the wiki page.

  • The commnet line can be placed in any position.
  • The commnet line doesn't affect other elements.


Prohibition

Block Elementcan contain other block elementscan be contained by other block elements
Paragraphnoyes
Prefpmattednoyes
Headingsnono
Tablenoyes
Table(CSV)noyes
List(unordered)yes*yes
List(ordered)yes*yes
Quoteyes*²yes
Horizontal Linenoyes
LEFT:/CENTER:/RIGHT:noyes
#refnoyes
#contentsnoyes*³
#commentnoyes*³
#pcommentnoyes*³
#articlenoyes*³
#vote(choice1,choice2,...)noyes*³

* As long as the beginning of Child Element is Inline Element or Paragraph, you can insert a Block Element to the next line. (Please refer to "Nesting Element" for an example.)

*²When Quotation is a Child Element of another Quotation, you need to increase the inentation level by 1.

*³ Due to pukiwiki's default setting of left margin, this is not recommended.


Compare Link Styles

Here is a section to explain the differences between WikiName, BracketName, InterWiki, Link, and Alias.

WikiName and BracketName

As you know by now, all of them are used in Pukiwiki to make a link to a page. And the difference betweem them is whether or not you can use spaces, multibyte-characters, symbols, and numbers. Thus, a BracketName would be a better choice if you want to avoid the typical WikiName capitalized link style. Usually, all Capitalized strings will be shown as a link. However, you can disable WikiNames in pukiwiki.ini.php if you think they are annoying.

InterWiki, Link, and Alias

These styles are very similar, so they might be confusing. But each of them has it's own purpose. If you understand the differences, they are all very useful.

First let's focus on their grammatical styles.

[[pukiwiki:Use PukiWiki]]..........[a]
[[whatever u like:http://pukiwiki.sourceforge.jp/?Use%20PukiWiki]]...[b]
[[Another Name>Text Formatting Rule]]......[c]

[a] is an InterWiki styled link. And [b] is a Link styled link. Finaly, both of them will direct us the same page: http://pukiwiki.sourceforge.jp/?Use%20PukiWiki . This is so, because pukiwi is defined in the InterWikiName as followins:

[http://pukiwiki.sourceforge.jp/? pukiwiki] utf8

Thus InterWiki combines two pieces of information. The first piece is a URL defined in InterWikiName, and the other is the information provided by the right side attribute. InterWikiName is a kind of short cut. You can define any URL for an InterWikiName.

For example, when you create an link to external/internal wiki page, it is annoying to have to type the whole URL each time you want to use it. In this case, as an alternative, you can define an InterWikiName.

As you can see, [c] is a Alias styled link. You can use it to display a different link text for a link to a page in PukiWiki.

In conclusion, the most important difference you need to understand is Which side is which?

Link StyleLeft SideRight Side
InterWikiInterWikiName(Defined URL)Additional URL
LinkLink textReal URL
AliasLink textReal URL(WikiName/BracketName)


Nesting Elements

Paragraph Element-Emphasize Element

~This is the paragraph, which is the parent element that contains the emphasized. 
''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 the emphasized. 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|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]
    TABLEELEMENTNEXTtothe Inlineelementin 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]

(The texts below are for the discussion in the translation team. Don't worry if it's written in Japanese:)

  • ええと、記録はどうしたらよいですかね?とりあえず前回からは、ほとんど進んでいません。 W3Cの勧告書を参考に翻訳中です。
  • Table 部分修正しました --merlin 2003-09-21 (日) 17:59:01
  • とりあえず、マニュアルで使われる英語パターンは出し尽くしたと思います。 使ったことの無い機能も使ってみないと・・・。--Olorin 2003-10-01 (水) 22:59:01
  • 添付についての部分を英訳してみました。訳語はよくわからない部分があったのでチェックをお願いします。--Tomos
  • 他に気になった点:"Horizon Line"は"Horizontal Line"でどうでしょう? Tomos
  • "Horizontal Line"の方が普通ですね。^^;どんどん直しちゃってください。 あと「ブロック要素に他の~要素を含めます。」の訳は「contain "other" ~ Element"s"」 という形に統一しようかな?と思っていますがどうでしょうかね?(子要素にいくつも他の要素が入る可能性があるので。) あと、プラグイン関係で行頭に#???を指定すると~って所の訳もいろいろ考えたのですが、 W3Cとかのを参考にしたりした結果 「行頭でを記述すると」=>When #comment is assigned at the beginning of a line, assignは結構堅い文で好まれる単語ですし、短くまとまっている?ので良いのではないかと思います。 あとは、アクセシビリティーも考えると強調タグよりダブル/シングルクオートでかこったほうがよいですかね? 取り消し線訳しました。Deletion...微妙か?--- Olorin
  • すみません、このページの日本語を分かりません。しかし、英語を直しました。 Sorry, I don't understand the Japanese on this page. But, I corrected the English. Note that all this talk about "child and parent elements" sounds quite strange to me. We should just use the words "contains" or "is contained by". ---Bjorn De Meyer
  • Don't worry we can use English as a public language. Anyway, thank you for your help. As regards your suggestion(Child and parent elements), it's quite natural of you to think its's strange that you use the words "Parent and Children. Have you ever read the XHTML recomenndation at W3C? We reffer to this document. Probably this is the reason why "Parent and Child" is used in this Text Formatting Rule. To tell the truth, I also tried to describe the Pukiwiki grammar without using "Parent and Child". Although reimy who is the leader of this project suggested that I wanted to reffer to W3C documents. Im my opinion, I keep using "Child & Parent" even if it sounds like professional or strange. Since we also have another "Help Document", which would be more easy to understand, I suppose. Any suggestiong is welcome.^^---Olorin
  • Well, yes, think I understand what you mean. But, I read the English version of the XHTML spec, and it doesn't use "Child and Parent" at all. On the contrary, look here: http://www.w3.org/TR/xhtml1/prohibitions.html I think it would be a good idea to group the "prohibitions" of the elements of the PukiWiki formatting elements in a similar paragraph. It will make the documentation more simple and easy to understand. I think we shouldn't rely on that other "Help document" too much. Each page of documentation should be self-sufficient. Also, we need more examples. Examples are the best form of documentation. Finally, some small points to help you improve your English:
    • When you write a comma or a point, always leave a space behind it.
    • The expression "feel strange" can only be used for emotions or the body, not for ideas. The expression you need to use for thoughts is "think it is strange". Examples: I think it is strange that you use the words "Parent and Children". If I eat something wrong, I will feel strange. Maybe I'm in love with her, because each time I see her, I feel strange. ^_^ ---Bjorn De Meyer
      • Ah, I'm really ashamed of my ridiculous wrong usage...(>_<) We should really take it into consideration that we need to rebuild this "Text Formatting rule", and make it simpler. Because I also can see unpleasant repeats of "can contain/cannot contain". Actually, Parent and Child elements are used in the documents of W3C. Google result

        Well, anyway, this document is definitely not friendly to pukiwiki-users since I had much difficulty to understand how to use some elements. So I investigated how table, and quotation elements are used at SandBox page... In my opinion, if I can seperate this page into 2 columns, it would be an ideal interface for new users as Wikipedia does. Wikipedia Help Page

        But, unfortunately, I have no idea how we can enable Block Elements in a Table Elements. I will ask Pukiwiki experts if we can imitate this page. Anyway,"Prohibition" section is a really nice idea. It should be included. And thank you for your good examples. Plus I also check my dictionary, too. So I never mistake how I should use "strange", maybe. lol --- Olorin 2003-10-08 (水) 18:50:01
      • Don't worry too much about your mistakes. My Japanese is far worse than your English. I'm easily ashamed too, because I make these errors. But, we also learn by making errors. So, let's overcome the shame, and turn it into our strength. ^_^ I agree, this document needs to be simplified. I like the Wikipedia documentation. I am going to try something similar in this FormattingSandbox. You are right, "parents" and "children" are used on the W3C web page, in places where I hadn't looked yet. -_- Maybe the prohibition section could be a table as well?
  • Added "Prohibition" section. --- Olorin
  • Added "Compare Link Styles". Finished InterWiki, BracketName, Link, and Alias. By the way, I think alias is not suitable for one of the Link Style name. Since it is especially used for CRIMINAL. What do you think about this? I know it's not much serious. But it's not good, in my opinion. (there was a critical misunderstanding. So i fixed my changes.) --- Olorin 2003-10-18 (土) 19:52:01
    • The word "alias" is indeed used for criminals in normal life. It means "also called" when talking about suspected criminals. However, when talking about informatics, it does not have a negative meaning. But something like "alternative name", or such could be used if you don't like that word. This link to a free online English dictionary may also help: http://www.dict.org ...
      • If you think that there's no problem, there's no problem. :-) I made little progress in inline element-entity section. slow progress thesedays... --- Olorin 2003-10-26 (日) 23:12:33
      • I added some examples from the FormattingSandbox, and also corrected some of the English. Oh, and in that table, 'X' means 'no', and 'O' means 'yes', right? Because in Europe, we use 'X' for no, and 'V' for 'yes'. Even "scoring by X and O" is something typically Japanese. --- Bjorn
      • Yes. 'O' means 'yes'. Probably, we should discard this method. We can smiply use 'yes' and 'no', which seems to cause no misunderstanding. In the meantime, Pukiwiki-1.4-final will be released in a week, according to the announce of pukiwiki dev team. And I think every English document is going to be included even if it is not perfect.--- Olorin &new(pagename[,nolink]): No such page;
  • http://www.w3.org/TR/xhtml1/definitions.html#terms 「云々できます」を can とするのはマニュアルらしくないでしょう。 -- e.e 2003-11-26 (水) 15:14:53
    • 「云々できます、してもいいですよ」は may。「しなきゃだめ」は must。「云々すべき」は should。「#commentは、他のブロック要素の子要素になることができますが、トップレベルに設置することを前提に左マージンを設定してありますので、他のブロック要素の子要素にはしないでください。」これとかshould.
    • http://en2.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page こことか参考になるかも。 -- e.e
    • とりあえず、まだ日本語な所はどんどん訳してみます。英語になれば、あとは友達に読んでもらっていくらでも推敲できるし。
    • それと、下のパターンのところでも問題になっている?んですが・・・。僕のは訳したところは、ChildElementとBlockElementをかなり多用しています。(直訳)でも、be contained by other Block Elementsの方が分かりやすいですよね?日本語での「子要素」はどうしたらいいですかね?Bjornさんとも、前に話したんですけどね。^^; -- olorin
  • いまさら、counter plugin のdefault 設定の記述ミスを修正 -- 2009-05-25 (月) 14:09:59

Translation patterns

  • #comment should not be contained by other Block Elements. Although #comment may be contained by other Block Elements, left margin is set, assuing it is placed at the top-level.
  • #ref may be contained by other Block Elements.
  • #ref may not accept other Block Element as a Child Element.

*1 #br placed right after an empty line next to a block element makes a line break that separates blocks. #br placed right after a block element makes a line break inside that block element. Unlike a line break in a wiki text, #br preserves the format of the line following it.

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2009-05-25 (月) 14:10:00
Site admin: PukiWiki Development Team

PukiWiki 1.5.2+ © 2001-2018 PukiWiki Development Team. Powered by PHP 5.6.38-0+deb8u1. HTML convert time: 0.406 sec.

OSDN