WikiML XML Reference

Block elements

heading

Equivalent of HTML's <h>

attributes

  • level = 0…7 - defines size of heading element (required)

example

<wikiml>
    <heading level="3">Hello Cruel World</heading>
</wikiml>

para

Equivalent of HTML's <p>.
Defines paragraph for text .

attributes

  • textAlign = "left | right | center | justify" (optional)
  • default value is left
  • class = "name of css class to apply"

style property groups

  • TEXT,
  • POSITION,
  • SPACING
  • DIMENSION
  • BACKGROUND
  • LIST
  • BORDER

example

<wikiml>
    <para>This is paragraph number 1</para>
    <para textAlign="justify">This is paragraph number 2 which is justified</para>
</wikiml>

block

Equivalent of HTML's <div>
Defines container for mixed content.
Inline and block elements can be nested inside block.
In two worlds it's just generic container for all content

attributes

  • class = "name of css class to apply"

style property groups

  • TEXT,
  • POSITION
  • SPACING
  • DIMENSION
  • BACKGROUND
  • LIST
  • BORDER

example

<wikiml>
    <block>
        <heading level="2">Hello !</heading>
        <para>My name is Luka</para>
    </block>
</wikiml>

table

Defines a table which contains rows and columns.
WikiML representation for row is tablerow tag .
WikiML representation for cell is tablecell tag.
Both of these are explained below.

Important table tag can
contain only tablerow tag

attributes

  • type = simple | advanced (optional)
    • default value is simple
  • class = "name of css class to apply"

example

<wikiml>
    <!-- Because I haven't specified type attribute WikiML assumes it is simple table  -->
    <table>
        <tablerow>
            <tablecell>Wikidot</tablecell>
            <tablecell>Rox !!</tablecell>
        </tablerow>
    </table>
</wikiml>

tablerow

Equivalent of HTML's <tr> tag.

Important tablerow tag can
contain only tablecell tag.

attributes

  • class = "name of css class to apply"

example

See table element example.

tablecell

Equivalent of HTML's <td> tag.
Inline and block elements can be nested inside tablecell.

attributes

  • columnSpan = 1…9999999
    • default value is 1
  • class = "name of css class to apply"

style property groups

  • TEXT
  • DIMENSION
  • BACKGROUND
  • SPACING
  • BORDER

example

<wikiml>
    <!-- Because I haven't specified type attribute WikiML assumes it is simple table  -->
    <table>
        <tablerow>
            <tablecell>Wikidot</tablecell>
            <tablecell>Rox !!</tablecell>
        </tablerow>
        <tablerow>
            <tablecell columnSpan="2">Wikidot - get your free wiki now !!</tablecell>
        </tablerow>
    </table>
</wikiml>

itemizedlist

Equivalent of HTML's <ul> tag .
WikiML representation for list item is listitem tag.

Important itemizedlist tag can
contain only listitem tag.

attributes

  • class = "name of css class to apply"

style property groups

  • LIST

example

<wikiml>
    <itemizedlist>
        <listitem>Item 1</listitem>
        <listitem>Item 2</listitem>
        <listitem>Item 3</listitem>
    </itemizedlist>
</wikiml>

numberedlist

Equivalent of HTML's <ul> tag .
WikiML representation for list item is listitem tag.

Important itemizedlist tag can
contain only listitem tag.

attributes

  • class = "name of css class to apply"

style property groups

  • LIST

example

<wikiml>
    <numberedlist>
        <listitem>Item 1</listitem>
        <listitem>Item 2</listitem>
        <listitem>Item 3</listitem>
    </numberedlist>
</wikiml>

listitem

Equivalent of HTML's <li> tag .
Inline and block elements can be nested inside listitem.

attributes

  • none

example

For example see itemizedlist or numberedlist documentation.

deflist

Equivalent of HTML's <dl> tag.

Important deflist tag can
contain only deftopic and defdescription tag.

attributes

  • none

example

<wikiml>
    <deflist>
        <deftopic>Wikidot</deftopic>
        <defdescription>The best wiki farm ever !</defdescription>
    </deflist>
</wikiml>

deftopic

Equivalent of HTML's <dt> tag.
Deftopic can contain only inline elements.

attributes

  • none

example

For example see deflist element documentation.

defdescription

Equivalent of HTML's <dd> tag.
Defdescription can contain inline and block elements.

attributes

  • none

example

For example see deflist element documentation.

hline

Equivalent of HTML's <hr /> tag.
Renders horizontal line page content.
It is used for separating page content etc.

attributes

  • none

example

<wikiml>
    <para>Wikidot is your destiny</para>
    <hline />
    <para>You know about it !</para>
</wikiml>

blockquote

Blockquote tag defines start of a long quotation .
To imagine how it works click here .

attributes

  • none

example

<wikiml>
    <blockquote>
        This is the portion of a very long quotation which is indented .
            <blockquote>
                This portion of very long quotation is indented two times. As you can see 
                blockquote elements can be nested .
            </blockquote>
    </blockquote>
</wikiml>

codeblock

Codeblock element is used to wrap a text which
is syntax of some programming language.
Such syntax is highlighted in appropriate way.

attributes

  • type = "php | java | c | etc…" (required)

example

<wikiml>
    <codeblock>
        if ( $beer->state == "empty" ) {
            throw new noLifeException() ;
        } else {
            $me->drinkMore($beer) ;
        }
    </codeblock>
</wikiml>

tableofcontents

Table of contents element, builds
table from headings which are present in
Wikidot document .
To imagine how it works click here

attributes

  • none

example

<wikiml>
    <tableofcontents />
    <heading level="1">Hello</heading>
    <heading level="2">Cruel</heading>
    <heading level="3">World</heading>
</wikiml>

image

Equivalent of HTML's <img> tag.

attributes

  • source = "url "|" flickr:photoid" | "/attachement/file " (required)
  • link = "wiki-page" | "url" - makes image a link to another page or web address .
  • alt = "text substitution when image not available"
  • class = "CSS class"
  • size = "square" | "thumbnail" | "small" | "medium" | "large" | "original" - for more information click here
  • align = "right" | "left" | "center" (if align is specified you can not use float attribute)

style property groups

  • DIMENSION

example

<wikiml>
    <image link="http://www.wikidot.com" class="images" alt="my private photo"  size="large" source="some-source" align="right" />
</wikiml>

bibliography

Creates a bibliography for document.
To imagine how it works click here.
Bibibliography element is container for bibitem elements.
It is very similar to unorderedlist element

attributes

  • title = "some text describing bibliography " (optional) ( if user does not secify any defaul value is Bibliography )

example

<wikiml>
    <para> The materials I have used for my homework </para>
    <bibliography title="Materials">
        <bibitem label="bell">Bell, J.; Hewish, A.; Pilkington, J. D. H.; Scott, P. F.; and Collins, R. A. Observation of a Rapidly Pulsating Radio Source. Nature 217, 709, 1968.</bibitem>
        <bibitem label="guy">Guy, R. K. Modular Difference Sets and Error Correcting Codes. §C10 in Unsolved Problems in Number Theory, 2nd ed. New York: Springer-Verlag, pp. 118-121, 1994.</bibitem>    
    </bibliography>
</wikiml>

bibitem

Building block of bibliography element.

attributes

  • label = "label describing bibliography item used for referencing bibliography somewhere in document " (required)

example

See bibliography element example.

bibcite

This element is used for referencing bibliography item (bibitem) from inside of document.

attributes

  • label = "label of bibitem to reference " (required)

example

<wikiml>
    <para> The materials I have used for my <bibcite label="guy">Guy R. Book</bibcite> homework </para>
    <bibliography title="Materials">
        <bibitem label="bell">Bell, J.; Hewish, A.; Pilkington, J. D. H.; Scott, P. F.; and Collins, R. A. Observation of a Rapidly Pulsating Radio Source. Nature 217, 709, 1968.</bibitem>
        <bibitem label="guy">Guy, R. K. Modular Difference Sets and Error Correcting Codes. §C10 in Unsolved Problems in Number Theory, 2nd ed. New York: Springer-Verlag, pp. 118-121, 1994.</bibitem>    
    </bibliography>
</wikiml>

Inline elements

subscript

Equivalent of HTML's <sub> tag.
Can contain inline elements.

attributes

  • none

example

<wikiml>
    <para>
        Lorem ipsum dolor sit amet, consectetuer adipiscing elit. <subscript>Aenean</subscript> pretium fringilla velit. Nulla eget enim sed est aliquam aliquam. Ut turpis     libero, condimentum a, commodo ut, malesuada eget, ante. Aliquam gravida, massa a egestas egestas, magna sem placerat tellus,
    </para>
</wikiml>

superscript

Equivalent of HTML's <sup> tag.
Can contain inline elements.

attributes

  • none

example

<wikiml>
    <para>
        Lorem ipsum dolor sit amet, consectetuer adipiscing elit. <superscript>Aenean</superscript> pretium fringilla velit. Nulla eget enim sed est aliquam aliquam. Ut turpis     libero, condimentum a, commodo ut, malesuada eget, ante. Aliquam gravida, massa a egestas egestas, magna sem placerat tellus,
    </para>
</wikiml>

newline

Equivalent of HTML's <br /> tag.

attributes

  • none

example

<wikiml>
    <para>
        Lorem ipsum dolor sit amet, consectetuer adipiscing elit.<newline /> Aenean pretium fringilla velit. Nulla eget enim sed est aliquam aliquam.
    </para>
</wikiml>

syntaxhint

This element is used for hints .

attributes

  • none

example

<wikiml>
    <block>
        <syntaxhint> some useful hint </syntaxhint>
    </block>
</wikiml>

strikethrough

It is quite obvious how it works.
If you want to imagine how it works
just click here.

attributes

  • none

example

<wikiml>
    <block>
        <para> I have made terrible <strikethrough>mstake</strikethrough> mistake </para>
    </block>
</wikiml>

email

Equivalent of HTML's <a href="mailto:boss@wikidot.com"> CEO email</a>
Content wrap for email addres

attributes

  • address = "moc.sserdda.liame|dilav#moc.sserdda.liame|dilav" (required)

example

<wikiml>
    <para>
        <!--When email is used only with address attribute and has no content it will display email address as a content-->
        Barbara Kowalski : <email address="barbara.kowalski@wikidot.com"/> 
        <!--In this case w will see tag content as a description-->
        Eric Cartman: <email address="eric85@wikidot.com">his personal e-mail address </email>
    </para>
</wikiml>

url

Equivalent of HTML's <a href="http://www.wikidot.com">www.wikidot.com</a>.
Element for wrapping url address.

attributes

example

<wikiml>
    <para>
        Wikidot url : <url to="http://www.wikidot.com" newWindow="true" />
        Wikidot url (another way of usage): <url to="http://www.wikidot.com">click to change your life</url>
    </para>
</wikiml>

link

Link is element for inter-wiki links.

attributes

  • ref = "element-id"
  • page = "page-name"
  • site = "site-name"
  • category = "category-name"

Available combinations of attributes:

site category page ref
x x x x
x x x
x x x
x x x
x x
x x
x x
x
x
x

example

<wikiml>
    <para>
        Check this <link page="example-page"/>
        Other amazing <link site="wiki-site" page="page-name" category="category-name">page </link>
        Jump to <link page="page-name" ref="element-id">this page</link>
    </para>
</wikiml>

anchor

Equivalent of HTML's <a name="ourAnchor"></a>

attributes

  • id = "page-section" (required)

example

<wikiml>
    <block>
        <anchor id="top" /> <!-- will display "section1" as text for description-->
        <para>text text text text text text text text<para>
        <link ref="top">Go to top of the page</link>
    </block>
</wikiml>

comment

Equivalent of HTML's <!— this text is comment —>

attributes

  • none

example

<wikiml>
    <block> 
        <comment>This piece of code needs update !!!</comment>
        <para>I am not complete </para>
    </block>
</wikiml>

bold

Equivalent of HTML's <strong> tag.

attributes

  • none

example

<wikiml>
    <block> 
        <para>Listen to me <bold>carefully</bold></para>
    </block>
</wikiml>

italic

Equivalent of HTML's <i> tag.

attributes

  • none

example

<wikiml>
    <block> 
        <para>Listen to me <bold><italic>carefully</italic></bold></para>
    </block>
</wikiml>

strong

Equivalent of HTML's <b> tag.

attributes

  • none

example

<wikiml>
    <block> 
        <para><strong>Listen</strong> to me <bold><italic>carefully</italic></bold></para>
    </block>
</wikiml>

underline

Equivalent of HTML's <span style="text-decoration:underline">text</span> .

attributes

  • none

example

<wikiml>
    <block> 
        <para><underline>This text is underlined </underline>-  How nice</para>
    </block>
</wikiml>

text

Equivalent of HTML's span .

attributes

  • class = "name of css class to apply"

style property groups

  • DIMENSION
  • TEXT
  • BACKGROUND
  • SPACING
  • BORDER
  • POSITION
  • LIST

example

<wikiml>
    <block> 
        <para><text class="some-class">This text is underlined </text>-  How nice</para>
    </block>
</wikiml>

Wikidot stylesheet attributes groups.

Idea

The idea is very simple. We have implemented selected css2 specification into WikiML.
CSS2 properties are available as WikiML attributes. The only difference is the naming convention.
In example : CSS text-align propery in WikiML is coded as textAlign . Values for properties
are exactelly the same.
Generally

  • single word CSS properties remains the same.
  • multi word CSS properties are written as camelCase without the separating "-" character. (text-align —> textAlign)

The below list is also the list of allowed (and parsed) style properties as given by the style attribute in either Wiki Syntax or parsed XHTML.

List of WikiML CSS attributes groups and their attributes.

  • BACKGROUND
    • backgroundAttachment
    • backgroundColor
    • backgroundImage
    • backgroundPosition
    • backgroundRepeat
  • BORDER
    • borderBottomColor
    • borderBottomStyle
    • borderBottomWidth
    • borderColor
    • borderLeftColor
    • borderLeftStyle
    • borderLeftWidth
    • borderRightColor
    • borderRightStyle
    • borderRightWidth
    • borderStyle
    • borderTopColor
    • borderTopStyle
    • borderTopWidth
    • borderWidth
  • DIMENSION
    • height
    • width
  • TEXT
    • fontFamily
    • fontSize
    • fontStretch
    • color
    • direction
    • letterSpacing
    • textAlign
    • textIndent
    • whiteSpace
    • wordSpacing
    • lineHeight
  • LIST
    • listStyleImage
    • listStylePosition
    • listStyleType
    • markerOffset
  • SPACING
    • marginBottom
    • marginLeft
    • marginRight
    • marginTop
    • paddingBottom
    • paddingLeft
    • paddingRight
    • paddingTop
  • POSITION
    • bottom
    • left
    • overflow
    • position
    • right
    • top
    • verticalAlign
    • zIndex
    • float
    • clear
docmarkupsyntaxv2wikimlxml
page revision: 10, last edited: 12 Mar 2008 11:27
Edit Tags History Files Print Site tools + Options
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License