@@ -10,35 +10,47 @@ newer.
1010
1111It contains:
1212
13- - a custom parser for Markdown and HTML to allow using MDITA and HDITA
14- as a source document format ,
13+ - a custom parser for Markdown and HTML to allow using Markdown and HDITA
14+ as source document formats ,
1515- and a transtype to generate Markdown from DITA source.
1616
17- The Markdown DITA files need to use a subset of Markdown constructs for
17+ ## Markdown source document formats
18+
19+ Markdown-based source files must use a subset of Markdown constructs for
1820compatibility with DITA content models.
1921
22+ Two different Markdown source formats are supported:
23+
24+ - [ Markdown DITA] ( https://github.com/jelovirt/org.lwdita/wiki/Markdown-DITA-syntax )
25+ - [ MDITA (LwDITA)] ( https://github.com/jelovirt/org.lwdita/wiki/MDITA-syntax )
26+
27+ For a comparison of these two formats, see [ Format comparison] ( https://github.com/jelovirt/org.lwdita/wiki/Format-comparison ) in the LwDITA Wiki.
28+
2029## Usage
2130
22- ### Using LwDITA files as input
31+ ### Using Markdown-based and HDITA files as input
2332
24- Markdown DITA or HTML DITA topics can only be used by linking to them in
33+ Markdown-based or HTML DITA topics can only be used by linking to them in
2534map files.
2635
2736``` xml
2837<map >
29- <topicref href =" test.md" format =" mdita" />
30- <topicref href =" test.html" format =" hdita" />
38+ <!-- Markdown DITA -->
39+ <topicref href =" test1.md" format =" md" />
40+ <topicref href =" test1.md" format =" markdown" />
41+
42+ <!-- MDITA -->
43+ <topicref href =" test2.md" format =" mdita" />
44+
45+ <!-- HDITA -->
46+ <topicref href =" test3.html" format =" hdita" />
3147</map >
3248```
3349
34- The ` format ` attribute value must be set to ` mdita ` or ` hdita ` in order
35- to recognize files as Markdown DITA or HTML DITA , respectively; the file
50+ The ` format ` attribute value must be set to the values shown above in order
51+ to recognize files as Markdown DITA, MDITA, or HDITA , respectively; the file
3652extension is not used to recognize format.
3753
38- See the [ syntax
39- reference] ( https://github.com/jelovirt/org.lwdita/wiki/Markdown-Syntax-reference )
40- for XML and Markdown DITA correspondence.
41-
4254### Generating Markdown output
4355
4456The DITA-OT LwDITA plug-in extends the DITA Open Toolkit with additional
0 commit comments