WebBUGS >> Main page Recent changes	Show source History
wiki syntax
This document explains all syntax features of core LionWiki. Syntax of tables (provided by plugin) is on separate page: Tables plugin. Headings Example: !Heading H2 !!Heading H3 !!!Heading H4 Heading H2 Heading H3 Heading H4 More exclamation marks you use, the smaller the heading will be (up to 5 exclamation marks). Exclamation marks has to be exactly at the beginning of the line. Lists Unordered list * Fruit Apple * Granny smith ** Orange * Vegetables Garlic Onion Fruit Apple Granny smith Orange Vegetables Garlic Onion Ordered list # First item ## First subitem ### First subsubitem ## Second subitem First item First subitem First subsubitem Second subitem Text styles ^^'Bold^^' → Bold (three apostrophes) ^Italic^ → Italic (two apostrophes) ^^^'Bold and italic^^^' → *Bold and italic* (five apostrophes) ^~~Strikethrough~~ → ~~Strikethrough~~ ^Underlined → Underlined ^Small text^ → Small text x^^{10^} → x¹⁰ x^_i^ → x_i CSS styles, classes, IDs Since LionWiki 3.1 {.first.second#id color: blue; font-size: large}Styled text span with ID and two classes{/} Styled text span with ID and two classes Classes begins with dot, ID with hash sign. Everything after first space is considered to be CSS style, so there can't be any space between or inside classes and ID. Few other possibilities: {. display: block;}Text{/} - neither class, nor id, just style {.citation}Text{/if} - just class The enclosing element is <span>. Emails, links, images Links to other pages can be created like this: ^Main page → Main page or ^Main project page → Main project page or ^Features header on Main page → Features header on Main page Emails and web links are automatically recognized: ^http://lionwiki.0o.cz → http://lionwiki.0o.cz lionwiki^@example.com → lionwiki@example.com You can use also relative links, but they have to start with ./ (otherwise it will be interpreted as Wiki page). So if you want to link some HTML page in the same directory, you use: ^Interesting page → Interesting page Or to use a relative path to a file on the same server but in a higher directory, you can use: ^Interesting File In Parent Directory → Interesting File In Parent Directory Images Image handling was changed a lot in the 3.2 release, see older version of this page if you use older version. If you need a way to upload images (or other files), check Upload plugin. ^[^http://lionwiki.0o.cz/lion.jpg] → You can use your image as your link: ^[^http://lionwiki.0o.cz/lion.jpg\|^link=^http://lionwiki.0o.cz/] → You can also place your image to the left or right, possibly combined with other features: ^[^http://lionwiki.0o.cz/lion.jpg\|^link=^http://lionwiki.0o.cz/\|center\|title=Big Lion\|alt=Alt text] More complex operations with images can be done with ImageExt plugin. Subpages Subpages are useful when you need to insert some common content into multiple pages, example could be a navigational menu (by the way, we have Menu plugin. Syntax: ^{include:page_to_be_included}. You can use the same syntax to include page in template (i.e. not in page content), but in this case, whole content of this subpage must be in HTML (you can, but not have to enclose it in ^{html} and ^{/html}). Multilingual content Let's say you have page named "Biography" in German and you would like to make French variant. Rename page Biography to Biography.de and create page named Biography.fr and insert French translation there. Then visitors whose browser identifies primary language as French will see Biography.fr. It's recommended to create a redirect from page Biography to default language variant. The obvious limitation is that page name has to stay the same in every language variant. That's not such a big problem with "Biography", but it can be worse with other names. This is recommended way to create multilingual content, there are more ways to do it. Redirects If you want to redirect from some page to other, put ^{redirect:page} at the very beginning of the page. It's not straightforward to edit page containing redirect because every visit will cause redirecting. The only way to edit such page is from search results (as it provides direct edit links), or possibly by manually altering URL. Other Headings Heading H2 Heading H3 Heading H4 Lists Unordered list Ordered list Text styles CSS styles, classes, IDs Emails, links, images Images Subpages Multilingual content Redirects Other Table of contents Characters Code Horizontal line Suppressing wiki syntax HTML code HTML entities Newline Internal comments LaTex equations Table of contents Automatically generated table of contents can be inserted with ^ Headings Heading H2 Heading H3 Heading H4 Lists Unordered list Ordered list Text styles CSS styles, classes, IDs Emails, links, images Images Subpages Multilingual content Redirects Other Table of contents Characters Code Horizontal line Suppressing wiki syntax HTML code HTML entities Newline Internal comments LaTex equations (see demo on the right). It can be used in both pages and templates. Characters Some sequences of characters are automatically replaced: Arrows : <^— : ←, ^→ : →, <^→ : ↔ Dash : ^— : — Copyrights : ^© or ^(C) : ©, ^® or ^(R) : ® Code Code syntax is useful when you need to keep original spacing and layout of text, especially for programming source code. ^ import sys if len(sys.argv) == 2: print "Hello",sys.argv^[1] does: import sys if len(sys.argv) == 2: print "Hello",sys.argv[1] We also have a plugin for syntax highlighting. Horizontal line by ^—^— Suppressing wiki syntax By using ^^ character before syntax keyword or using ^ something . If you still don't know how, take a look on wiki code of this page, there are plenty of examples. If you want to insert ^^ character, you have to double it, i.e. ^^^^ HTML code Do you want to insert youtube video to your site? Or any other HTML code? Just insert it between ^{html}some html code{/html}. This does not have to work if config value $NO_HTML is set to true. Note that it is serious security risk if you allow users to post HTML code in your wiki. HTML entities HTML entities are automatically recognized and left without modification. Newline LionWiki joins adjacent newlines together, if you need more than one newline, use ^ . Internal comments You can insert internal comments not intended to be displayed using HTML-like syntax ^<!^— text not intended to be displayed ^→ LaTex equations LaTeX is supported using mathjax. For inline equation, use \( \) . For display equation, use {{%% %%}} and within is using \[ \]

	Powered by LionWiki. Last changed: 2014/07/30 15:57 Erase cookies	Show source History

wiki syntax

This document explains all syntax features of core LionWiki. Syntax of tables (provided by plugin) is on separate page: Tables plugin.

Headings

Example:

!Heading H2
!!Heading H3
!!!Heading H4

Heading H2

Heading H3

Heading H4

More exclamation marks you use, the smaller the heading will be (up to 5 exclamation marks). Exclamation marks has to be exactly at the beginning of the line.

Lists

Unordered list

* Fruit
** Apple
*** Granny smith
** Orange
* Vegetables
** Garlic
** Onion

Fruit

Apple

Granny smith

Orange

Vegetables

Garlic
Onion

Ordered list

# First item 
## First subitem 
### First subsubitem
## Second subitem

First item

First subitem

First subsubitem

Second subitem

Text styles

^^'Bold^^' → Bold (three apostrophes)

^Italic^ → Italic (two apostrophes)

^^^'Bold and italic^^^' → Bold and italic (five apostrophes)

^~~Strikethrough~~ → ~~Strikethrough~~

^Underlined → Underlined

^Small text^ → Small text

x^^{10^} → x¹⁰

x^_i^ → x_i

CSS styles, classes, IDs

Since LionWiki 3.1

{.first.second#id color: blue; font-size: large}Styled text span with ID and two classes{/}

Styled text span with ID and two classes

Classes begins with dot, ID with hash sign. Everything after first space is considered to be CSS style, so there can't be any space between or inside classes and ID. Few other possibilities:

{. display: block;}Text{/} - neither class, nor id, just style
{.citation}Text{/if} - just class

The enclosing element is <span>.

Emails, links, images

Links to other pages can be created like this:

^Main page → Main page

^Main project page → Main project page

^Features header on Main page → Features header on Main page

Emails and web links are automatically recognized:

^http://lionwiki.0o.cz → http://lionwiki.0o.cz

lionwiki^@example.com → lionwiki@example.com

You can use also relative links, but they have to start with ./ (otherwise it will be interpreted as Wiki page). So if you want to link some HTML page in the same directory, you use:

^Interesting page → Interesting page

Or to use a relative path to a file on the same server but in a higher directory, you can use:

^Interesting File In Parent Directory → Interesting File In Parent Directory

Images

Image handling was changed a lot in the 3.2 release, see older version of this page if you use older version.

If you need a way to upload images (or other files), check Upload plugin.

^[^http://lionwiki.0o.cz/lion.jpg] →

You can use your image as your link: ^[^http://lionwiki.0o.cz/lion.jpg|^link=^http://lionwiki.0o.cz/] →

You can also place your image to the left or right, possibly combined with other features:

^[^http://lionwiki.0o.cz/lion.jpg|^link=^http://lionwiki.0o.cz/|center|title=Big Lion|alt=Alt text]

More complex operations with images can be done with ImageExt plugin.

Subpages

Subpages are useful when you need to insert some common content into multiple pages, example could be a navigational menu (by the way, we have Menu plugin.

Syntax: ^{include:page_to_be_included}.

You can use the same syntax to include page in template (i.e. not in page content), but in this case, whole content of this subpage must be in HTML (you can, but not have to enclose it in ^{html} and ^{/html}).

Multilingual content

Let's say you have page named "Biography" in German and you would like to make French variant. Rename page Biography to Biography.de and create page named Biography.fr and insert French translation there. Then visitors whose browser identifies primary language as French will see Biography.fr. It's recommended to create a redirect from page Biography to default language variant. The obvious limitation is that page name has to stay the same in every language variant. That's not such a big problem with "Biography", but it can be worse with other names.

This is recommended way to create multilingual content, there are more ways to do it.

Redirects

If you want to redirect from some page to other, put ^{redirect:page} at the very beginning of the page. It's not straightforward to edit page containing redirect because every visit will cause redirecting. The only way to edit such page is from search results (as it provides direct edit links), or possibly by manually altering URL.

Other

Automatically generated table of contents can be inserted with ^

(see demo on the right). It can be used in both pages and templates.

Characters

Some sequences of characters are automatically replaced:

Arrows : <^— : ←, ^→ : →, <^→ : ↔
Dash : ^— : —

Code

Code syntax is useful when you need to keep original spacing and layout of text, especially for programming source code.

import sys
if len(sys.argv) == 2:
   print "Hello",sys.argv^[1]

does:

import sys
if len(sys.argv) == 2:
   print "Hello",sys.argv[1]

We also have a plugin for syntax highlighting.

Horizontal line

by ^—^—

Suppressing wiki syntax

By using ^^ character before syntax keyword or using ^

something

. If you still don't know how, take a look on wiki code of this page, there are plenty of examples. If you want to insert ^^ character, you have to double it, i.e. ^^^^

HTML code

Do you want to insert youtube video to your site? Or any other HTML code? Just insert it between ^{html}some html code{/html}. This does not have to work if config value $NO_HTML is set to true. Note that it is serious security risk if you allow users to post HTML code in your wiki.

HTML entities

HTML entities are automatically recognized and left without modification.

Newline

LionWiki joins adjacent newlines together, if you need more than one newline, use ^
.

Internal comments

You can insert internal comments not intended to be displayed using HTML-like syntax ^<!^— text not intended to be displayed ^→

LaTex equations

LaTeX is supported using mathjax. For inline equation, use

\( \)

. For display equation, use

{{%% %%}} and within is using \[  \]

Show source History