:CategoryDev/Document/FormattingSandbox

:CategoryDev/Document
:CategoryDev/Document/Text Formatting Rule

This is a testing document for PukiWiki's Formatting rules. It may be used as examples for the documentation later on. ---Bjorn
Oh! It's a very useful format for summarizing Text Formatting Rule. --merlin 2003-10-15 (水) 12:35:09
Wow. Your immediate work is astonishing to me! Added the description for "line breaking at end of the line". I think this is what you reffered, Bjorn. And ,probably, you can use include plug-in to insert formatted headings. But it requires another page to be included... I also added Nesting Elements from Text Formatting Rule. ---Olorin 2003-10-16 (木) 01:11:09
Thanks, both of you for the compliments. ^_^ I have cleaned up a little a bit more.----Bjorn
Some updates. "contents plugin" which usually shows the table of contents is disabled here. --- olorin
This page is almost finished! Thank you for your making the nice base page, Bjorn. The rest is Plugin... --- olorin
Here are examples.

Inline Elements†

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

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 example	Formatting code	Comment
Emphasised text	''Emphasised text''	Put the text between two single quotes.
Italic text	'''Italic text'''	Put the text between three single quotes.
~~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(): The style ref(filename,pagename) is ambiguous and become obsolete. Please try ref(pagename/filename);	&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 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(): File not found: "pukiwiki.png" at page ":CategoryDev/Document/FormattingSandbox";	[[ref-plugin>FrontPage]]	Of course, you can use an attached file for the image-link.

↑

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 entity	Code	Comments
FormattingSandbox	&page;	This returns the name of current page. (i.e. if the page name is "Pukiwiki/1.4", this returns "1.4".)
:CategoryDev/Document/FormattingSandbox	&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.
17:28:19	&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) 17:28:19	&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.
17:28:19	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) 17:28:19	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.

↑

Numeric entities :†

Numeric entity	Code	Comments
		This a normal space,
∞	∞	We could go on like this forever...
Ω	&;	But here it must end.
å	å (in decimal)	represents the letter "a" with a small circle above it (used, for example, in Norwegian).
å	å (in hexadecimal)	represents the letter "a" with a small circle above it.
И	И (in decimal)	represents the Cyrillic capital letter "I": И.
水	水 (in hexadecimal)	represents the Chinese character for water: 水.
[	[	represents the [ sign.
]	]	represents the ] sign.
ї	ї	As you can se, you're able to define any unicode character up to #32000 like this.

↑

Misc†

Format example	Formatting code	Comment
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)
	&counter;	Shows the access log counter.
1	&online;	Shows the curecnt number of the visiters.
	&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

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|

aaa	bbb	ccc
111	222	333

↑

Advanced†

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

Header	Header2	Header3
footer	colspan
lowspan	bbb	ccc
lowspan	222	333

↑

CSV Table†

,aaa , bbb , ccc
,1111,2222,3333

aaa	bbb	ccc
1111	2222	3333

↑

Plug-ins†

#contents

(This is the table of contents plugin)

↑

Nesting Elements†

↑

Paragraph Element-Emphasize Element†

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

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

↑

Quotation Element-List Element†

Level[0]
-List Level 1
>Quote Level 1(List Level 1)
<Quite Quote Level 1(List Level 1)//quite Quote Block without finishing List Block
>Quote Level 1-a(List Level 1)
>>Quote Level 2(List Level 1)
<<Quite Quote Level 2(List Level 1)
<Quite Quote Level 1-a(List Level 1)
|back|to|List Level 1|with|table|
--List Level 2 (List Level 2) 
|back|to|List Level 2|with|table|//add a table block to a list block
--List Level 2 (List Level 2) &br; Line Break(List Level 2)
---List Level 3
>Quote Level 1-a(List Level 3)
>>Quote Level 2-a(List Level 3)
-List Level 1(Quote Level 2-a/List Level 3)
<<Quite Quote Level 2(List Level 3)
<Quite Quote Level 1(List Level 3)
-List Level 1

Level[0]

List Level 1
Quote Level 1(List Level 1)
Quite Quote Level 1(List Level 1)
Quote Level 1-a(List Level 1)

Quote Level 2(List Level 1)

Quite Quote Level 2(List Level 1)
Quite Quote Level 1-a(List Level 1)
back to List Level 1 with table
- List Level 2 (List Level 2)
  back to List Level 2 with table
- List Level 2 (List Level 2)
  Line Break(List Level 2)
  - List Level 3
    Quote Level 1-a(List Level 3)
    Quote Level 2-a(List Level 3)
    
    List Level 1(Quote Level 2-a/List Level 3)
    Quite Quote Level 2(List Level 3)
    Quite Quote Level 1(List Level 3)
List Level 1

↑

Enhancements with Plug-in†

↑

How can I attach/upload files and images?†

Required Plug-ins: "Attach" and "Ref"
How to

First, you need to upload the file or image by using "attach plug-in". You can recognise the icon of "clip"- something like these: or , 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".
If you fihish uploading the file or image, you can call the uploaded ones by using "ref plug-in"

total:
today:
yesterday:
now: 1