Help

Conceptions

Types of page:

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

Glossary:

title
every blog and article has it, comments page inherits it from main page
summary
see title
name
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
sublog
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

Tags

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

<figure>
<fig>
<note>
notice
<impo>
something important
<warn>
warning
<pre>
code block
<p>
paragraph

<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.

Inline

<sup>
is used to specify superscript
<sub>
is used to specify subscript
<b>
is used to boldface some text
<brite>
is used to emphasize some text with colour
<c>
is used to mark up a command or user input
<e>
is used to apply emphasis to a word or phrase
<path>
is used to mark text that refers to an on-disk file
<img src="http://www.w3.org/Icons/valid-xhtml10-blue"/>
is used to add an image; example gives image
<br/>
is used to place a line break
in text
<mail>
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>
<uri>
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

<comment>
comments relevant to the action(s) that appear after the comment
<i>
distinguishes user input from displayed text
<keyword>
denotes a keyword in the language used in the code sample
<ident>
used for an identifier
<const>
used for a constant
<stmt>
used for a statement
<var>
used for a variable
<uri>
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>.

Lists

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

Lists are block-level elements.

Tables

<table>
table, contains optional <tcolumn> elements and one or more <tr>
<tcolumn width="width"/>
defines column width
<tr>
table row, contains one or more <th> or <ti> elements
<th>
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
<ti>
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