An extension of the oXygen XML Editor DITA framework that recognizes Markdown structures and allows users to convert them to the corresponding DITA markup.
This project shows how oXygen can help people that know Markdown to transition to DITA. They can write Markdown fragments in DITA paragraphs and these will be recognized, they will be notified and offered to replace the Markdown fragment with the corresponding DITA markup.
Just clone or download the project and open the ditaMark.xpr file in oXygen XML Editor standalone and the framework should be automatically installed. Open then a DITA topic, like the frameworks/ditaMark/sample.dita if you want a sample file, or test.dita if you want to start from an empty file, both from this project, and in paragraphs add Markdown content and observe the reported messages and the offered solutions - below you can find details on what is handled.
Another option to install the framework is to drop the frameworks/ditaMark folder inside oXygen XML Editor frameworks folder, or you can define the project frameworks folder in oXygen Preferences -- Document Type Associations -- Locations as a folder containing frameworks.
You can also test it online using the oXygen XML Web Author, the test link opens the test.dita topic that should provide proposals to convert Markdown fragments to DITA.
From a technology point of view, this project uses Schematron for validation and Schematron Quick Fixes (SQF) for providing the automatic conversions as quick fixes.
Examples of the Markdown fragments that are recognized and converted to DITA are described below.
Something like
* item 1
* item 2
* item 3
will be converted to
<ol>
<li>item 1</li>
<li>item 2</li>
<li>item 3</li>
</ol> rendered as
-
item 1
-
item 2
-
item 3
You can also use - instead of * to start unordered list items.
Something like
1. item 1
2. item 2
3. item 3
will be converted to
<ol>
<li>item 1</li>
<li>item 2</li>
<li>item 3</li>
</ol>rendered as
- item 1
- item 2
- item 3
Something like
> quote text
> quote text
> quote text
is converted to
<lq>
<p>quote text</p>
<p>quote text</p>
<p>quote text</p>
</lq> that renders as
quote text quote text quote text
Something like ( note that additional spaces are added below between ` symbols, in order to make them visible in the Markdown code block)
` ` `
1+1=2
2+2=4
` ` `
results into a codeblock element
<codeblock>
1+1=2
2+2=4
</codeblock>rendered as
1+1=2
2+2=4
Something like
This is a `test` for inline code.
is converted to
This is a <codeph>test</codeph> for inline quotes. rendered as
This is a test for inline code.
Links are also detected and converted to cross references.
See the [oXygen website](http://www.oxygenxml.com)
for more details.
is converted to
See the <xref format="html" href="http://www.oxygenxml.com" scope="external">oXygen website</xref>
for more details.rendered as
See the oXygen website for more details.
Or we can have quick links like
<http://www.oxygenxml.com>
and these also can be converted to DITA cross references
<xref format="html" href="http://www.oxygenxml.com" scope="external"/>rendered as
An image using Markdown format will be converted to a figure or image element,
depending whether there is a title or not.
In this case we have a title, so we should get a figure
which is a block!
results in
In this case we have a title, so we should get a figure
<fig>
<title>One of the oXygen logos</title>
<image href="https://www.oxygenxml.com/img/resources/oxygen190x62.png">
<alt>oXygen logo</alt>
</image>
</fig> which is a block!rendered as
In this case we have a title, so we should get a figure
which is a block!
If we do not have a title then an inline image element is generated
In this case we obtain only an image  which is rendered inline.
generates
In this case we obtain only an image <image href="https://www.oxygenxml.com/img/resources/oxygen190x62.png">
<alt>oXygen logo</alt></image> which is rendered inline.rendered as
In this case we obtain only an image 
We can convert tables with header row:
|test|table|conversion|
|-|-|-|
|1|2|3|
|1|2|3|
converted to something like
<table id="table_ub4_44j_rx">
<tgroup cols="3">
<colspec colname="col1"/>
<colspec colname="col2"/>
<colspec colname="col3"/>
<thead>
<row>
<entry>test</entry>
<entry>table</entry>
<entry>conversion</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>2</entry>
<entry>3</entry>
</row>
<row>
<entry>1</entry>
<entry>2</entry>
<entry>3</entry>
</row>
</tbody>
</tgroup>
</table>We can similarly convert tables without a header row:
|-|-|-|
|1|2|3|
|1|2|3|
to
<table id="table_a1k_lnk_rx">
<tgroup cols="3">
<colspec colname="col1"/>
<colspec colname="col2"/>
<colspec colname="col3"/>
<tbody>
<row>
<entry>1</entry>
<entry>2</entry>
<entry>3</entry>
</row>
<row>
<entry>1</entry>
<entry>2</entry>
<entry>3</entry>
</row>
</tbody>
</tgroup>
</table>Sections can be easily created by using ## to mark their title.
## New section
results in something like
<section id="section_i5l_nnk_rx">
<title>New section</title>
<p/>
</section>On the last paragraph you can use # to mark an inner or sibling topic title
# New topic
This will result in something like:
<topic id="topic_201610210051370300">
<title>New topic</title>
<body>
<p/>
</body>
</topic>Copyright 2018 Syncro Soft SRL.
This project is licensed under Apache License 2.0