Markup Mapping
This page describes the mapping from tbwiki markup language to reStructuredText for the conversion of documentation to Sphynx and readthedocs. (see Issue_0046)
mapping [edit section]
headers [edit section]
item | tbwiki | reStructuredText
____________________|_____________________|____________________
| |
| | =========
1st level heading | = Heading 1 = | Heading 1
| | =========
____________________|_____________________|____________________
| |
2nd level heading | == heading 2 == | Heading 2
| | =========
____________________|_____________________|____________________
| |
3rd level heading | === Heading 3 === | Heading 3
| | ---------
____________________|_____________________|____________________
| |
4th level heading | ==== Heading 4 ==== | Heading 4
| | `````````
____________________|_____________________|____________________
| |
inline markup [edit section]
item | tbwiki | reStructuredText
_________|___________________|____________________
| |
bold | '''bold''' | **bold**
| |
italic | ''italic'' | *italic*
| |
link | http://foo | http://foo
| |
anchor | ?? | .. _name:
| |
link | | :ref:`name`
| |
page | [[Page Name]] |
| |
bullet | * item | * item
| (first level must | (first level must follow an empty line)
| be indented) |
| |
blocks and quoted [edit section]
item | tbwiki | reStructuredText
_____________|________________________________|____________________
| |
block | {{{ | previous para::
| indented | indented
| content | content
| }}} | previous indentation level
_____________|________________________________|____________________
| |(exact match not found yet)
| | previous para::
colored | {{{#!YellowBox | content
block | content | previous indentation level
| }}} |
_____________|________________________________|____________________
| |
labeled | |
offset block | (not available) | .. note:: content in note block
_____________|________________________________|____________________
| |
links [edit section]
item | tbwiki | reStructuredText
_____________|________________________________|____________________
| |
URL | http://example.com/ | `http://example.com/`_
_____________|________________________________|____________________
| |
URL with | [[http://example.com|Example]] | `Example http://example.com/`_
cover text | |
_____________|________________________________|____________________
| |
internal | [[#Section Name]] | `Section Name`_
_____________|________________________________|____________________
| |
page | [[Page Name]] | :ref:`Page Name`_
_____________|________________________________|____________________
| |
define | (not available) | .. _new_label:
anchor | |
_____________|________________________________|____________________
| |
define | (not available | `Example`_
URL separate | | ...
from cover | |
text | | .. _Example: http://example.com/
| |
_____________|________________________________|____________________
| |
Macros and directives [edit section]
item | tbwiki | reStructuredText
_____________|________________________________|____________________
| |
include | {{Include(page-or-ref)}} | .. include: included-file.txt
_____________|________________________________|____________________
| |