![[PukiWiki-official]](image/pukiwiki-official.png "[PukiWiki-official]")
FAQinEnglish * FormatRule * FormatExample
In the following table you can see how to use the inline text elements of PukiWiki
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 example | Formatting code | Comment |
| Emphasized text | ''Emphasized text'' | Put the text between two single quotes. |
| Italic text | '''Italic text''' | Put the text between three single quotes. |
| %%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 background | &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. |
http://www.example.com | &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. |
| Format example | Formatting code | Comment |
| WikiName | WikiName | This 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.com | http://www.example.com | The 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. |
 | [[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 |
| [[the image's URL>FrontPage]] | This enables you to make an imagw-link to a page in Pukiwiki with a different name. |
 | [[&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 plugin" 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 omitted. |
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 entity | Code | Comments |
| 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-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. |
| &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 see, you can define any Unicode character like this. |
| Format example | Formatting code | Comment |
| Inline text Inline text | Inline text&br;Inline text | &br; is replaced with a line break. |
| Inline text~ #plugin | Inline text~ #plugin | The ~, followed by a line break works as an escape character that disables the # character, which normally activates a plugin. cf.Paragraph(Block Elements) |
| &counter; | Shows the access log counter. | |
| 1 | &online; | Shows the current number of the visitors. |
| &version; | &version; | Shows the version number of PukiWiki itself |
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. There is a space in front of this text.
Preformatted text. There is a space in front of this text.
*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.
~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 plugins.)
Line break escape example
#comment (disables first letter formatting rule, which is used to activate plugins.)
>Quote Level 1 >>Quote Level 2 >>>Quote Level 3
Quote Level 1
Quote Level 2
Quote Level 3
-Unordered list level 1 --Unordered list level 2 ---Unordered list level 3
+Ordered list level 1 ++Ordered list level 2 +++Ordered list level 3
:Definition|Description
A comment is hidden here: //Comment
A comment is hidden here:
----
|aaa|bbb|ccc| |111|222|333|
| aaa | bbb | ccc |
| 111 | 222 | 333 |
|RIGHT:100|CENTER:|SIZE(20)|c -------------- format definition line |~Header|Header2|Header3|h ----------------- header line |CENTER:rowspan|COLOR(red):bbb|ccc| |~|222|COLOR(#ff0000):BGCOLOR(yellow):333| |footer|>|CENTER:colspan|f ----------------- footer line
| Header | Header2 | Header3 |
|---|---|---|
| footer | colspan | |
| rowspan | bbb | ccc |
| 222 | 333 | |
,aaa , bbb , ccc ,1111,2222,3333
| aaa | bbb | ccc |
| 1111 | 2222 | 3333 |
#contents
(This is the table of contents plugin)
"Attach" and "Ref"
? what does "ref plugin" 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 didn't work.
- in the document add &ref(myimage.gif); <= with semicolon
|
Site admin: PukiWiki Development Team
PukiWiki 1.5.4+ © 2001-2022 PukiWiki Development Team. Powered by PHP 5.6.40-0+deb8u12. HTML convert time: 0.768 sec. |
|
pukiwiki.png