Syntax Guide

Here's a simple guide to get you familiar with the parsers syntax.

Headers

Headers are formatted using a string of equal characters

e.g. =====H1 Header===== ====H2 Header==== ===H3 Header===

If a H1 header is found on the first line of the document this will be automatically used as the title although this dose not work with html tags.

Page Variables

With page variables you can manually set the pages appearance and other meta data.

Custom Title  : Must be on first line.
    #title Title Name
Restrict Page : Users to restrict access to(separated by commas).
    #restrict user1,user2,user3
Hidden Text   : Text here is only visible in source.
    ^^Text to hide :O^^

Note: Titles must be on the first line of the document and must be followed by a new line.

Links

The parser has an internal linking system that lets you link to any page on your site by just typing the base name and the display name.

e.g. {{home|Go to home}}

You may also use any kind of bbcode or other formatting syntax e.g. hi !

Tip: If you add a link that points to a page that dose not exist it will be colored red and will display a 404 message and date on hover event, It will remain like this until the respective page is created and the current page has been reprocessed.

Auto Links

The parser will automatically convert plain text links into clickable ones unless they are in a html tag or code block. e.g. http://ameoto.com/

Code Blocks

Code blocks can be used to hold preformatted text as well as contain any internal syntax and not parse it.

[b]This text is to be [i]IGNORED![/i][/b]

GeSHi

Support for GeSHi syntax highlighting can be added by copying the /geshi/ folder into the /paper/ directory of WhiteCrane.

e.g. [geshi=c]int i = 20;[/geshi]

BBCode

Rather then writing up a brand new markdown that you would have to learn we have used simple BBCode for face type editing.

Supported markup:
Bold text
Italic text
Underlined text
Strike Out
Colored Text
Resized text
img-smile.gifimg-biggrin.gif

Center floating content.

Right floating content.

[img] and [url] tags are also supported along with embedding of YouTube content.

If you want to see exactly how all this is done just hit edit to see the code used.

Plugins

Plugins allow you to extend WhiteCranes functionality to your needs.

Updated Documentation at http://dev.ameoto.com/extensions/

+