Doxer Markup

This is a description of the Doxer Markup format.

The markup is modeled after syntax features from several public wikis, optimized for ease of use and for writing source code documentation.

The parser is robust and always generates valid XHtml, regardless of the input.

Text Markup

Result Wiki text
emphasize ''emphasize''
strong **strong**
code ``code``
strong and emphasize ''**strong and emphasize**''
strong and code ``**strong and code**`` 
Leading spaces (4+) indicate
preformatted         regions

Leading spaces (4+) indicate
preformatted         regions
~~! Invisible comments (see HTML source) !~~
Force line
break 		Force line%%%break
~~/x ... x/~~
disable markup parsing, 'x' is any custom character 		~~// ~~/x ... x/~~ //~~
disable markup parsing, 'x' is any custom character

Paragraph Markup

Result Wiki text

Left justified text paragraph.

~~left~~
Left justified text paragraph.

Centered text paragraph.

~~center~~
Centered text paragraph.

Right justified text paragraph.

~~right~~
Right justified text paragraph.

Block justified text paragraph useful for newspaper style paragraph formatting. This text is intentionally very long so it spans multiple lines of text to force block justified line wrapping.

~~justify~~
Block justified text paragraph useful for newspaper style paragraph formatting. This text is intentionally very long so it spans multiple lines of text to force block justified line wrapping.

(Horizontal Separator)

----
(Horizontal Separator)
Footnote: [1] This is a footnote paragraph with link: http://rapicorn.testbit.eu/doxer.html Footnote: ~~(This is a ''footnote'' paragraph with link: http://rapicorn.testbit.eu/doxer.html)~~

Link Markup

Result Wiki text
WikiPageName [[WikiPageName]]
Wiki Page (custom title) [[WikiPageName| Wiki Page (custom title)]]
http://rapicorn.testbit.eu/doxer.html http://rapicorn.testbit.eu/doxer.html
The testbit website [[http://testbit.eu/ | The testbit website]]
TestAnchor [[#TestAnchor | TestAnchor]]
Anchor Link [[http:#TestAnchor | Anchor Link]]
Image ALT text
[[image:http://testbit.eu/nosuchdir/nosuchimage.xyz | Image ALT text]]
http://testbit.eu/favicon.ico
[[image:http://testbit.eu/favicon.ico]]
Image with flags
[[image:http://testbit.eu/favicon.ico | frame | Image with flags]]
Flags: left right center float frame noborder
testbit.eu
[[image:http://testbit.eu/favicon.ico|http://testbit.eu|testbit.eu]]

Section Markup

Result Wiki text

Heading1

=======Heading1=======

Heading2

======Heading2======

Heading3

=====Heading3=====

Heading4

====Heading4====
Heading5
===Heading5===
Heading6
==Heading6==
  • First
  • Next
    • Nested
    • Other bullet
    • Alternative bullet
  • Last 
* First
* Next
  * Nested
  + Other bullet
  - Alternative bullet
* Last

  1. One
  2. Two
    1. Nested
  3. Three 
# One
# Two
  # Nested
# Three

Table markup

Tables can have captions, headers and cells. Also, tables can be rendered in different styles. Available table style classes are: doxer-default, doxer-slim, doxer-noframe. Tables start with {| and end with |}. Captions are separated with |+ and rows are separated with |-. Cells are started by a double bar || following a newline and may be separated by more double bars || on the same line. Header cells use newline and !! as bars in a similar manner.

Multiplication Table

* 1 2 3 4 5
2 2 4 6 8 10
3 3 6 9 12 15
4 4 8 12 16 20 
{| doxer-default
|+Multiplication Table
|-
!! * !! 1 !! 2 !! 3 !! 4 !! 5
|-
!! 2
|| 2 || 4 || 6 || 8 || 10
|-
!! 3
|| 3 || 6 || 9 || 12 || 15
|-
!! 4
|| 4 || 8 || 12 || 16 || 20
|}

Slim Table

+ 1 2 ~~r~~
1 2 3 Row joins
2 3 4
~~c~~ Cell joins 
{| doxer-slim
|+Slim Table
|-
!! + !! 1 !! 2 !! ~~/* ~~r~~ */~~
|-
!! 1 || 2 || 3 || Row joins
|-
!! 2 || 3 || 4 || ~~r~~
|-
!! ~~/* ~~c~~ */~~ || Cell joins || ~~c~~ ||
|}

DIV sections

Named DIV sections (for HTML) generation are supported with {{ + section name + | and as end marks }}. Example:

Framed section. 

{{doxer-frame|
Framed section.
}}
[1] This is a footnote paragraph with link: http://rapicorn.testbit.eu/doxer.html