[ 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.
Renders multiple text lines as block eleemnt.
In YakiBiki, these style elements are handled as block element.
*Heading
Put * at head of line. There're 4 levels, *, **, ***, ****, each marks apply to <h3> - <h6>.
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.
>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.
- 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
- Level 2
- Level 2_1
- Level 2_2
Put "-" at head of line. Double or Triple "-" makes nested list.
Putting "+" in place of "-" makes numbered list.
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
|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 ",".
// 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.
Represents a line, or continuous characters in line.
In YakiBiki, these style elements are handled as inline element.
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
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
Set "Alias>URL" or "Alias>MailAddress" makes links which display text is "Alias".
[[Google>http://www.google.com]] [[Some Mail Address>admin@example.com]]
See following samples
'' Emphasis '' Emphasis with **Asterisk** '''Italic''' Italic with *Asterisk* %%StrikeOutLine%%
Emphasis
Emphasis withAsterisk
Italic
Italic withAsterisk
StrikeOutLine
((Footnote))
Surrondig text with double parenthesis makes footnote.
// 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.
Introduces other element, hints.
You can use "pre" inline plugin ... such as &pre(){*, |, [, #, & }.
→
You can use "pre" inline plugin to display wiki format special characters such as *, |, [, #, & .
You can insert "void" plugin at head of line. "void" inline plugin is replaced to empty character
&void()*Emphasis, Not Heading.*
Emphasis, Not Heading.
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 |
Putting four or more "-" at head of line displays horizontal line (<hr />).
----
Putting double "/" at head of line indicates comment line, YakiBiki doesn't output in HTML.
// doesn't be displayed till line-end.
You can use HTML Character Entities(character name, code) such as greek, symbol characters.
see, http://www.w3.org/TR/html4/sgml/entities.html
  | | |
¡ | ¡ | ¡ |
¢ | ¢ | ¢ |
£ | £ | £ |
¤ | ¤ | ¤ |
¥ | ¥ | ¥ |
¦ | ¦ | ¦ |
§ | § | § |
¨ | ¨ | ¨ |
© | © | © |
ª | ª | ª |
« | « | « |
¬ | ¬ | ¬ |
| ­ | ­ |
® | ® | ® |
¯ | ¯ | ¯ |
° | ° | ° |
± | ± | ± |
² | ² | ² |
³ | ³ | ³ |
´ | ´ | ´ |
µ | µ | µ |
¶ | ¶ | ¶ |
· | · | · |
¸ | ¸ | ¸ |
¹ | ¹ | ¹ |
º | º | º |
» | » | » |
¼ | ¼ | ¼ |
½ | ½ | ½ |
¾ | ¾ | ¾ |
¿ | ¿ | ¿ |
× | × | × |
À | À | À |
Á | Á | Á |
 |  |  |
à | à | à |
Ä | Ä | Ä |
Å | Å | Å |
Æ | Æ | Æ |
Ç | Ç | Ç |
È | È | È |
É | É | É |
Ê | Ê | Ê |
Ë | Ë | Ë |
Ì | Ì | Ì |
Í | Í | Í |
Î | Î | Î |
Ï | Ï | Ï |
Ð | Ð | Ð |
Ñ | Ñ | Ñ |
Ò | Ò | Ò |
Ó | Ó | Ó |
Ô | Ô | Ô |
Õ | Õ | Õ |
Ö | Ö | Ö |
Ø | Ø | Ø |
Ù | Ù | Ù |
Ú | Ú | Ú |
Û | Û | Û |
Ü | Ü | Ü |
Ý | Ý | Ý |
Þ | Þ | Þ |
ß | ß | ß |
" | " | " |
& | & | & |
< | < | < |
> | > | > |
→ | → | → |
← | ← | ← |
↑ | ↑ | ↑ |
↓ | ↓ | ↓ |
⇒ | ⇒ | ⇒ |
⇐ | ⇐ | ⇐ |
⇑ | ⇑ | ⇑ |
⇓ | ⇓ | ⇓ |
⇔ | ⇔ | ⇔ |
↔ | ↔ | ↔ |
↵ | ↵ | ↵ |
– | – | – |
— | — | — |
‘ | ‘ | ‘ |
’ | ’ | ’ |
‚ | ‚ | ‚ |
“ | “ | “ |
” | ” | ” |
„ | „ | „ |
† | † | † |
‡ | ‡ | ‡ |
‰ | ‰ | ‰ |
€ | € | € |
⋅ | ⋅ | ⋅ |
◊ | ◊ | ◊ |
∅ | ∅ | ∅ |
⌈ | ⌈ | ⌈ |
⌋ | ⌋ | ⌋ |
∏ | ∏ | ∏ |
− | − | − |
∗ | ∗ | ∗ |
∉ | ∉ | ∉ |
⌊ | ⌊ | ⌊ |
⌉ | ⌉ | ⌉ |
〈 | 〈 | ⟨ |
〉 | 〉 | ⟩ |
∼ | ∼ | ∼ |
≅ | ≅ | ≅ |
≈ | ≈ | ≈ |
≤ | ≤ | ≤ |
≥ | ≥ | ≥ |
≠ | ≠ | ≠ |
∞ | ∞ | ∞ |
∴ | ∴ | ∴ |
∈ | ∈ | ∈ |
∋ | ∋ | ∋ |
⊆ | ⊆ | ⊆ |
⊇ | ⊇ | ⊇ |
⊂ | ⊂ | ⊂ |
⊃ | ⊃ | ⊃ |
∪ | ∪ | ∪ |
∩ | ∩ | ∩ |
∧ | ∧ | ∧ |
∨ | ∨ | ∨ |
∀ | ∀ | ∀ |
∃ | ∃ | ∃ |
∠ | ∠ | ∠ |
⊥ | ⊥ | ⊥ |
∂ | ∂ | ∂ |
∇ | ∇ | ∇ |
≡ | ≡ | ≡ |
√ | √ | √ |
∝ | ∝ | ∝ |
∫ | ∫ | ∫ |
⊄ | ⊄ | ⊄ |
∑ | ∑ | ∑ |
⊕ | ⊕ | ⊕ |
⊗ | ⊗ | ⊗ |
[ HelpTop ]