16908 views

 

27% MelonadeM

::|CONTENTS

1. Firki Syntax
2. Firki on BotB
3. Link Tokens
4. Text Style Tokens
5. Block Tokens
6. Firki BotB futures

Firki is an experimental lightweight markup language

which loosely resembles syntactical concepts found in both BBCode

and WikiText

. With the help of Firki the firteen writing staff could format their own articles' sense of look and style while only learning one cryptically simple markup language instead of the confusing fusion of both HTML and CSS.

Firki Syntax

---

There are three basic marks which are used to build a Firki token. So long as the token is formated properly Firki can translate the token into browser-understandable HTML*CSS. It should be known that Firki has very little to no error handling! :D

Teh 3 Firki Marks

'[ => opening tick mark/symbol
followed by an action identifier (aka param0)

[ => parameter separator mark/symbol
followed by the next parameter for the action

] => closing delimiter mark/symbol
ends the token

So in example --
'[param0[param1[param2[param3[...etc...[paramX]

"param0" is the action identifier for the Firki token. The following parameters are extensions or commands of said action identifier. The amount of parameters to pass in a token depends on what the action is looking for.

Some actions may have optional parameters. In the case that default settings are desired for an optional parameter then the parameter space should be empty (no spaces, nothing) between the token marks.

example
'[l[http://n00b.com] => http://n00b.com

Firki on BotB

---

BotB's Lyceum uses an optimized (or, rather a stripped-down) version of the Firki markup language originally created for a CMS craptank style blog-o-sphere. It is used in place of HTML due to HTML's hackable nature. And BotB can not afford to trust no one (double negetive there =X what does it mean?!?!!?)!

Link Tokens

---

URL Link

'[l[URL[linktext]

example
'[l[http://n00b.com[n00b] => n00b

Link to Lyceum Article

'[[Article_Title]

example
'[[n00b] => n00b

The hyperlink will be in red if the article does not yet exist.

Text Style Tokens

---

bold
'[b]bold'[/b]

oblique / italic
'[o]oblique / italic'[/o]

underline
'[u]underline'[/u]


Start Text Class Span
'[t[(text class)]

End Text Class Span
'[/t]

Available Text Classes : code,0, 1, 2, 3, 4, b0, b1, b2, b3, b4

NOTE :: BotB text default == Text Style '1'.

example
'[t[b0]n00b'[/t] => n00b

Block Tokens

---

Insert Image
Please review uploading pics for general stuff on that.

'[i[image_id[(alignment)]

image_id => the number associated with the uploaded image
alignment => an optional parameter; working values are 'r', 'right', 'l', 'left'

example
'[i[10[r] =>


Mark Chapter
If chapters are marked than a Table of Contents box will appear at the upper-left corner of the article which links to each chapter.

'[#[Chapter_Title]

Firki BotB futures

---

More markups are coming. We shan't be specific until they are released in whenever patches.