home home search search -  login login  | help help

WikiFormat

[ HelpTop ]

Special Thanks to KinoWiki. Wiki Parser of YakiBiki is based on KinoWiki.
These help documents are based on KinoWiki help, too.
YakiBiki was not existed If KinoWiki was not.


Block Element

Renders multiple text lines as block eleemnt.
In YakiBiki, these style elements are handled as block element.

  • Heading
  • Formatted Text
  • Blockquote
  • List
  • Defenition List
  • Table
  • BlockPlugin

Heading

*Heading

Put * at head of line. There're 4 levels, *, **, ***, ****, each marks apply to <h3> - <h6>.

Formatted Text

 Formatted Text with html escape.
^ Space
* "><&' *
^ TAB character
Formatted Text with html escape.
* "><&' *

Put half-width space or tab character at head of line. Wiki style formats in formatted text don't be parsed as wiki.

Blockquote

>quoted text

quoted text

Put ">" at head of line.
Note, if you insert " "(half-width-space) between ">" and first character like below, it will be displayed as "Blockquote of formatted text".

> quoted text
 ^ half-width-space

Be careful when you copy and paste block quote text from e-mail, forum page, e.t.c.

List

- Level 1
-- Level 1_1
-- Level 1_2
--- Level 1_2_1
+ Level 2
++ Level 2_1
++ Level 2_2
  • Level 1
    • Level 1_1
    • Level 1_2
      • Level 1_2_1
  1. Level 2
    1. Level 2_1
    2. Level 2_2

Put "-" at head of line. Double or Triple "-" makes nested list.
Putting "+" in place of "-" makes numbered list.

Defenition List

Definition1
Description1Description1Description1
Description1
Definition2
Definition3
Description1

Surrounding text with ":" makes definition list.
You can insert line-break in description because descriptions are handled as block element.
But empty line means end of definition list. If you want to insert empty line in description, use "block" plugin.

:Definition1:#block||>Description1

Description1

Description1
||<
:Definition2:Description2
Definition1

Description1

Description1

Description1

Definition2
Description2

Table

|Heading1|Heading2|hR
|contents1|contents2|
|contents3|contents4|c
|CENTER:contents5|RIGHT,BGCOLOR(yellow):contents6|
|AAAAAAAAAAA|BBBBBBBBBBB|H
Heading1 Heading2
contents1 contents2
contents3 contents4
contents5 contents6
AAAAAAAAAAA BBBBBBBBBBB

Partitioning columns by "|" makes table.
Putting "h" at end of line makes its line heading("<th>").
Putting "l", "c", "r" at end of line makes its line alignments "left", "center", "right".
If you want to set alignment to each cells individually, begin cell contents with "LEFT:", "CENTER:", "RIGHT:" prefix.
"BGCOLOR(colorname)" changes back ground color. Join these modifications with ",".

BlockPlugin

// non arguments.
#plugin_name||

// param1 only.
#plugin_name|param1|

// param1 + param2 (param2 can include empty lines)
#plugin_name|param1|>
param2
||<

// param2 only.
#plugin_name||>
param2
||<

You can use Wiki Plugin if installed. See detailed descriptions for each plugins.
See below links for available plugins in YakiBiki default setup. Plugins which "Type" is "block" are BlockPlugin.

Inline Element

Represents a line, or continuous characters in line.
In YakiBiki, these style elements are handled as inline element.

  • URL, mail address
  • YakiBiki-Link(BracketLink)
  • Emphasis, Italic, StrikeOutLine modifications
  • Footnote
  • InlinePlugin

URL, mail address

URLs and mail addresses in text are automatically converted into external links.

URL : http://www.google.com/
mail address : admin@example.com

URL : http://www.google.com/
mail address : admin@example.com

YakiBiki-Link(BracketLink)

Bracket Link Variations Examples

# Without Alias
[[http://www.google.com/]]
[[yb://relative/link/path]]
[[admin@example.com]]
[[1]] to FrontPage ID
[[SideBar]]

# With Alias
[[AliasName>http://www.google.com/]]
[[AliasName>yb://relative/link/path]]
[[AliasName>admin@example.com]]
[[AliasName>1]]
[[AliasName>SideBar]]

Surrounding YakiBiki page name or id with double brackets makes internal links for YakiBiki.

Link to FrontPage(By ID) -> [[1]]
Link to FrontPage(By page name) -> [[FrontPage]]

Link to FrontPage(By ID) -> FrontPage
Link to FrontPage(By page name) -> FrontPage

Displays links if urls or mail addresses were surrounded.

Link to Google -> [[http://www.google.com/]]
Link to mail address -> [[admin@example.com]]

Link to Google -> http://www.google.com/
Link to mail address -> admin@example.com

Displays relative path to _YB('url') if you start "yb://".

[[yb://dir1/dir2/dir3/image.jpg]]
->
_YB('url') + '/dir1/dir2/dir3/image.jpg

https://www.glamenv-septzen.net/en/dir1/dir2/dir3/image.jpg

Set "Alias>URL" or "Alias>MailAddress" makes links which display text is "Alias".

[[Google>http://www.google.com]]
[[Some Mail Address>admin@example.com]]

Google
Some Mail Address

Emphasis, Italic, StrikeOutLine modifications

See following samples

'' Emphasis ''
Emphasis with **Asterisk**
'''Italic'''
Italic with *Asterisk*
%%StrikeOutLine%%

Emphasis
Emphasis withAsterisk
Italic
Italic withAsterisk
StrikeOutLine

Footnote

((Footnote))

Surrondig text with double parenthesis makes footnote.

InlinePlugin

// non arguments.
&plugin_name()

// param1 only.
&plugin_name(param1)

// param1 + param2.
&plugin_name(param1){ param2 }

// param2 only.
&plugin_name(){ param2 }

You can use Wiki Plugin if installed. See detailed descriptions for each plugins.
See below links for available plugins in YakiBiki default setup. Plugins which "Type" is "inline" are InlinePlugin.

Others

Introduces other element, hints.

How to display special characters handled as Wiki style format by default ?

You can use "pre" inline plugin ... such as &pre(){*, |, [, #, & }.


You can use "pre" inline plugin to display wiki format special characters such as *, |, [, #, & .

How to put * at head of line, not as heading style format.

You can insert "void" plugin at head of line. "void" inline plugin is replaced to empty character

&void()*Emphasis, Not Heading.*

Emphasis, Not Heading.

line-break plugin

You can use "br" inline plugin when you want to insert line-break in table cell contents.

| aaaa &br() bbb | cccc dddd |
aaaa
bbb
cccc dddd

Horizontal Line

Putting four or more "-" at head of line displays horizontal line (<hr />).

----

Comment

Putting double "/" at head of line indicates comment line, YakiBiki doesn't output in HTML.

// doesn't be displayed till line-end.

HTML Character Entities

You can use HTML Character Entities(character name, code) such as greek, symbol characters.
see, http://www.w3.org/TR/html4/sgml/entities.html

ISO 8859-1 (Latin1) series
  &#160; &nbsp;
¡ &#161; &iexcl;
¢ &#162; &cent;
£ &#163; &pound;
¤ &#164; &curren;
¥ &#165; &yen;
¦ &#166; &brvbar;
§ &#167; &sect;
¨ &#168; &uml;
© &#169; &copy;
ª &#170; &ordf;
« &#171; &laquo;
¬ &#172; &not;
­ &#173; &shy;
® &#174; &reg;
¯ &#175; &macr;
° &#176; &deg;
± &#177; &plusmn;
² &#178; &sup2;
³ &#179; &sup3;
´ &#180; &acute;
µ &#181; &micro;
&#182; &para;
· &#183; &middot;
¸ &#184; &cedil;
¹ &#185; &sup1;
º &#186; &ordm;
» &#187; &raquo;
¼ &#188; &frac14;
½ &#189; &frac12;
¾ &#190; &frac34;
¿ &#191; &iquest;
× &#215; &times;
À &#192; &Agrave;
Á &#193; &Aacute;
 &#194; &Acirc;
à &#195; &Atilde;
Ä &#196; &Auml;
Å &#197; &Aring;
Æ &#198; &AElig;
Ç &#199; &Ccedil;
È &#200; &Egrave;
É &#201; &Eacute;
Ê &#202; &Ecirc;
Ë &#203; &Euml;
Ì &#204; &Igrave;
Í &#205; &Iacute;
Î &#206; &Icirc;
Ï &#207; &Iuml;
Ð &#208; &ETH;
Ñ &#209; &Ntilde;
Ò &#210; &Ograve;
Ó &#211; &Oacute;
Ô &#212; &Ocirc;
Õ &#213; &Otilde;
Ö &#214; &Ouml;
Ø &#216; &Oslash;
Ù &#217; &Ugrave;
Ú &#218; &Uacute;
Û &#219; &Ucirc;
Ü &#220; &Uuml;
Ý &#221; &Yacute;
Þ &#222; &THORN;
ß &#223; &szlig;
Marks, Symbols
" &#34; &quot;
& &#38; &amp;
< &#60; &lt;
> &#62; &gt;
&#8594; &rarr;
&#8592; &larr;
&#8593; &uarr;
&#8595; &darr;
&#8658; &rArr;
&#8656; &lArr;
&#8657; &uArr;
&#8659; &dArr;
&#8660; &hArr;
&#8596; &harr;
&#8629; &crarr;
&#8211; &ndash;
&#8212; &mdash;
&#8216; &lsquo;
&#8217; &rsquo;
&#8218; &sbquo;
&#8220; &ldquo;
&#8221; &rdquo;
&#8222; &bdquo;
&#8224; &dagger;
&#8225; &Dagger;
&#8240; &permil;
&#8364; &euro;
&#8901; &sdot;
&#9674; &loz;
Mathematical symbols
&#8709; &empty;
&#8968; &lceil;
&#8971; &rfloor;
&#8719; &prod;
&#8722; &minus;
&#8727; &lowast;
&#8713; &notin;
&#8970; &lfloor;
&#8969; &rceil;
&#9001; &lang;
&#9002; &rang;
&#8764; &sim;
&#8773; &cong;
&#8776; &asymp;
&#8804; &le;
&#8805; &ge;
&#8800; &ne;
&#8734; &infin;
&#8756; &there4;
&#8712; &isin;
&#8715; &ni;
&#8838; &sube;
&#8839; &supe;
&#8834; &sub;
&#8835; &sup;
&#8746; &cup;
&#8745; &cap;
&#8743; &and;
&#8744; &or;
&#8704; &forall;
&#8707; &exist;
&#8736; &ang;
&#8869; &perp;
&#8706; &part;
&#8711; &nabla;
&#8801; &equiv;
&#8730; &radic;
&#8733; &prop;
&#8747; &int;
&#8836; &nsub;
&#8721; &sum;
&#8853; &oplus;
&#8855; &otimes;




[ HelpTop ]