logo
The Falcon Programming Language
A fast, easy and powerful programming language
Location: Developers community >> Wiki Parser >> Wiki docs
User ID:
Password:
 

Wiki Parser


wikiParser quickref

This guide explains the whole wikiparser syntax.

Block formating

Headers

they start with one or more equal signs = followed by your title.

ie === My beautiful header will render an h3 HTML header.

Paragraphs

By default, they need a new line before and after them, but this can be fixed to your needs.

A paragraph is just a container with some non-blank lines of text inside. If you want to force a linebreak inside them, use \ at the end of the line.

Sample

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Source Code

Source code is are special zones wich will be rendered verbatim. They start with a {{{ followed by optional spaces, and an optional langage-name, ending with }}} . For example:


{{{ fal

for i in [1,2,3,"a","b","c"]
    > "i is now: ", i
end
}}}

will render the following:

Sample


for i in [1,2,3,"a","b","c"]
    > "i is now: ", i
end

you can also highlight other langages, even if they are not worth studying once you know Falcon :)

Some other langages are supported, like C++ :

//: C07:Stash3.h
// Function overloading
#ifndef STASH3_H
#define STASH3_H

class Stash {
  int size;      // Size of each space
  int quantity;  // Number of storage spaces
  int next;      // Next empty space
  // Dynamically allocated array of bytes:
  unsigned char* storage;
  void inflate(int increase);
public:
  Stash(int size); // Zero quantity
  Stash(int size, int initQuantity);
  Stash();
  int add(void* element);
  void* fetch(int index);
  int count();
};
#endif // STASH3_H ///:

Horizontal line

Just put 3 or more minus signs (dashes) - on a line.

Sample


Lists

Lists are composed of list items.

Enumerated lists

Lists contains list items. A list item starts with the * sign, followed by optional spaces and your text. A list item is ended when a new one starts. A list is ended when there's a newline.

List items can also be nested, * signs indicate the nesting level.

Sample
  • Coffee
  • Tea
    • Green tea
    • Black tea
  • Milk

Numerated lists

A list item starts with the # sign, followed by optional spaces and your text. A list item is ended when a new one starts. A list is ended when there's a newline.

List items can also be nested, # signs indicate the nesting level.

Sample
  1. Coffee
  2. Tea
    1. Green tea
    2. Black tea
  3. Milk

Table Of Contents

Just write ... optionaly followed by some spaces and the word TOC.

Sample

You already got it at the top of the page.

Tables

Write like this:

|=Column1|=Column2|=Column3|=Column4|
|Cell 1.1|Cell 1.2|Cell 1.3|Cell 1.4|
|Cell 2.1|Cell 2.2|Cell 2.3|Cell 2.4|
|Cell 3.1|Cell 3.2|Cell 3.3|Cell 3.4|

Sample

Let's see if they're working fine :

Column1 Column2 Column3 Column4
Cell 1.1 Cell 1.2 Cell 1.3 Cell 1.4
Cell 2.1 Cell 2.2 Cell 2.3 Cell 2.4
Cell 3.1 Cell 3.2 Cell 3.3 Cell 3.4

Multipages document

You can even have a main document containing other pages. Inside the main page, ie "main.wiki" use {{pages:one,two,three}} and inside the other pages ("one.wiki", "two.wiki", "three.wiki") use {{toppage:main}}

Inline formatting

Inside each paragraph or list, you can use inline rules.

Thoses rules can be mixed, and may expend on several lines.

Escaping

Use the tilde char "~" to escape an inline rule, and write two tildes signs to obtain one.

Bold

Like this : **bolded text**

Sample

Like this : bolded text

Italics

Like this : //italic text// (note that it is not recommanded end a line with italic markup, as it may be interpreted as a line break.)

Sample

italic text

Underline

Like this : __underlined text__

Sample

Like this : underlined text

Stroke

Like this : --stroked text--

Sample

Like this : stroked text

Sup and Sub text

Like this : sup^^text^^ or sub..text..

Sample

Like this : suptext or subtext

Monospace

Like this : {{monospaced text}}

Sample

Like this : monospaced text

Link to other pages in the same wiki

Like this: [Another page] Or like this: [Another page|Aliased]

Sample

Like this: Another page Or like this: Aliased

URLs

Like this : [[http://www.falconpl.org|FalconPL]]

Sample

Like this : FalconPL

Images

Like this : [[im http://falconpastebin.appspot.com/static/i/FalconIcon.png|http://falconpastebin.appspot.com/static/i/FalconIcon.png|center|Falcon logo]]

Sample

Like this :

Falcon logo

Quotes

Like this : [~Falcon is GREAT~]

Sample

Like this :

Falcon is GREAT


Go To Page...

Loading

Elapsed time: 0.050 secs. (VM time 0.045 secs.)