Name: help
Summary: short description of concepts and syntax of blagowiki engine
Author: parafin
Created: Sat, 27 Dec 2008 22:25:46 GMT
Last update: Sun, 11 Jan 2009 15:57:51 GMT by parafin
Atom feed
Modify access level: moderator



Types of page:

well, article is article
is simply a list of articles + a list of other blogs
every article and blog has corresponding page with comments
is a database of registered users, there is only one page of this type ("Users" link from menu at the top)


every blog and article has it, comments page inherits it from main page
see title
name is path to page relative to the root of site, it's determined from url when page is created and can't be changed
every blog can have a list of blogs, which is called sublogs, the idea behind this is to have a concept similar to categories or keywords but which is more simple and flexible


General information

Content of article or comment is XML-fragment with all accepted tags described below. Comment can consist of text and inline tags, article - of one or more <chapter> tags. Because of XML nature, you have to convert any < or & to &lt; and &amp; correspondly, also in tag's attributes' values " have to be converted to &quot;.

Note: You can use either full, relative or absolute links in <uri> tag. In the third case link is actually related to engine's root, not website's (if BlagoWiki is installed into root directory of website, then there is no difference).

Sections and chapters

Block-level elements

something important
code block

<note>, <impo>, <warn> and <p> contains text and inline elements. <pre> contains text and own set of elements.

Lists and tables are also block-level elements.


is used to specify superscript
is used to specify subscript
is used to boldface some text
is used to emphasize some text with colour
is used to mark up a command or user input
is used to apply emphasis to a word or phrase
is used to mark text that refers to an on-disk file
<img src=""/>
is used to add an image; example gives image
is used to place a line break
in text
is used to create hyperlink to some e-mail address; you can use either <mail>e-mail</mail> or <mail link="e-mail">some text</mail>
is used to create hyperlink; for mailto: links use <mail>; you can use either <uri>hyperlink</uri> or <uri link="hyperlink">some text or img tags or both</uri>

All inline tags except <img/>, <br/>, <mail> and <uri> can contain other inline tags and text.

Tags, allowed in code blocks

comments relevant to the action(s) that appear after the comment
distinguishes user input from displayed text
denotes a keyword in the language used in the code sample
used for an identifier
used for a constant
used for a statement
used for a variable
see inline elements

All elements from above list (except <uri> obviously) can contain any element from the same list and text. <comment> also can contain inline tag <b>.


unordered list, contains one or more <li> tags
ordered list, contains one or more <li> tags
definition list, contains one or more <dt> and <dd> tags
list item, can contain text, inline tags, <ul> and <ol>tags
definition term, can contain text and inline tags
definition description, can contain text, inline tags, <ul> and <ol>tags

Lists are block-level elements.


table, contains optional <tcolumn> elements and one or more <tr>
<tcolumn width="width"/>
defines column width
table row, contains one or more <th> or <ti> elements
header cell of table, may contain text and inline elements; also may have colspan, rowspan and align attributes, which have the same meaning as in html
item (cell) of table, may contain text, lists, <fig> elements (see block-level elements) and inline elements; for attributes see description above for <th> tag

Tables are block-level elements.

See also