Here are examples.

Inline Elements

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

Text Decorations

The expressions are supposed to work with the default settings. The first 5 expressions are defined in default.ini.php. The others which starts with "&" and "footnote" is powered by respective plugins. See default.ini.php to change the settings for the former ones. See respective plugins for the latter ones.

Format exampleFormatting codeComment
Emphasised text''Emphasised text''Put the text between two single quotes.
Italic text'''Italic text'''Put the text between three single quotes.
Strikethrough text%%Strikethrough text%%
Underlined text%%%Underlined text%%%
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};
yellow text with black backbround&color(yellow,black){yellow text with black background};
1((This is the footnote's text))This inserts a footnote with the given text at the bottom of the page.
www.example.com
#ref(): ERROR: File not found: "pukiwiki.png" at page "FormatExample"
&ref(http://www.example.com);
&ref(./pukiwiki.png,alt-title-puki-img);
This inserts a reference.
It also inserts attached images.
&aname(Anchor);This inserts an invisible anchor for hyperlinking.

Link Styles

Format exampleFormatting codeComment
WikiNameWikiNameThis creates a link to another page on the same Pukiwiki site.
BracketName?[[BracketName]]This creates a link to another page on the same Pukiwiki site.
http://www.example.comhttp://www.example.comThe easiest way to make an external link, as you can see. :-P
External link[[External link:http://www.example.com]]This creates links to pages on other web sites.
http://pukiwiki.org/image/pukiwiki.png[[the image's URL:http://www.example.com]]This creates image-links to pages on other web sites.
pukiwiki:FrontPage[[pukiwiki:FrontPage]]InterWiki Styled Link
Alias[[Alias>FrontPage]]This enables you to make a link to a page in Pukiwiki with a different name.
Alias[[Alias>pukiwiki:FrontPage]]Advanced Link style: the combination of Alias and InterWiki
http://pukiwiki.org/image/pukiwiki.png[[the image's URL>FrontPage]]This enables you to make an imagw-link to a page in Pukiwiki with a different name.
#ref(): ERROR: File not found: "pukiwiki.png" at page "はじめてのPukiWiki/14"[[&ref(Wiki-Page-Where-The-Image-Is-Attached/Image-Name,OPTION1,ALT);>FrontPage]]Of course, you can use an attached file for the image-link.
"ref plug-in" has many option to explain... please wait for the translation to come... If the image is attached on the same page, "Wiki-Page-Where-The-Image-Is-Attached" can be ommited.

Special entities :

These expressions are supposed to work with the default settings. See rules.ini.php to change the definition, and see pukiwiki.ini.php to change the date/time format.

Special entityCodeComments
FormatExample&page;This returns the name of current page.
(i.e. if the page name is "Pukiwiki/1.4", this returns "1.4".)
FormatExample&fpage;This returns the full name of current page.
(i.e. if the page name is "Pukiwiki/1.4", this returns "Pukiwiki/1.4".)
2004-01-16&date;This returns date according to the defined date format in rules.ini.php
Reffer to "$date_format" in the file.
18:27:44&time;This returns date according to the defined date format in rules.ini.php
Reffer to "$time_format" in the file.
2004-01-16 (FRI) 18:27:44&now;This returns the current time.
2004-01-16date ?This returns date according to the defined date format in rules.ini.php
Reffer to "$date_format" in the file.
18:27:44time ?This returns date according to the defined date format in rules.ini.php
Reffer to "$time_format" in the file.
2004-01-16 (FRI) 18:27:44now ?This returns the current time.
&heart;&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.
 This a normal space,
--And this is a minus sign.
☎As you can se, you an define any unicode character like this.

Misc

Format exampleFormatting codeComment
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.
cf.Paragraph(Block Elements)
3295&counter;Shows the access log counter.
1&online;Shows the curecnt number of the visiters.
&version;&version;Shows the version number of PukiWiki itself

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|
aaabbbccc
111222333

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
HeaderHeader2Header3
footercolspan
lowspanbbbccc
222333

CSV Table

,aaa , bbb , ccc
,1111,2222,3333
aaabbbccc
111122223333

Plug-ins

#contents

(This is the table of contents plugin)


Enhancements with Plug-in

How can I attach/upload files and images?

Required Plug-ins

"Attach" and "Ref"

How to
  1. First, you need to upload the file or image by using "attach plug-in". You can recognise the icon of "clip"- something like these:attach.png or file.png, at the bottom of the page. Or there may exist a "text link" which leads you to the upload page at the top, but it depends on the "skin".
  2. If you fihish uploading the file or image, you can call the uploaded ones by using "ref plug-in"

Comments

? what does "ref plug-in" mean? I imagine the images go into some directory relative to the document? So I tried the following:

- step 1: upload an image called "myimage.gif"
- in the document add &ref("myimage.gif")

but this didnt work.

  • Please try: -- henoheno? 2004-10-23 (土) 15:23:43
    - in the document add &ref(myimage.gif); <= with semicolon
  • Updated the infomation for Link with "ref plug-in". check "Link Styles" table again, pls.

Please enter your name or handle in first box , and enter comment in second box.