XMLmind logo

XMLmind DITA Converter Manual

  

3. MDITA support Previous topic Parent topic Child topic Next topic

XMLmind DITA Converter fully supports MDITA Opens in new window, which specifies how to write DITA topics and maps in Markdown Opens in new window.

Template of an MDITA topic lwdita_templates/mdita_topic.md Opens in new window:
---
id: ???
---

# Topic title here

Short description here.

Topic body starts here.
Template of an MDITA map lwdita_templates/mdita_map.md Opens in new window:
# Map title here {.map}
   
- [???](???)
  - [???](???)
  - [???](???)
- [???](???)
Notice the {.map} class attribute added to the title of the map. Without it, the above template would be translated to a DITA topic.

§ Implementation specificities

  • The encoding of an MDITA file is, by default, the system encoding (e.g. window-1252 on a Western PC).
    If you want to explicitly specify the encoding of an MDITA file, please save your file with a UTF-8 or UTF-16 BOM (Byte Order Mark) or add an encoding directive inside a comment anywhere at the beginning of your file. Example:
    <!-- -*- coding: iso-8859-1 -*- -->

Heading
=======

## Sub-heading

Paragraphs are separated
by a blank line.
    The above example should work fine because ditac understands the GNU Emacs file variable Opens in new window called coding.
  • Adding a {.concept} class attribute to the title of an MDITA topic may be used to generate a DITA concept rather than a DITA topic.
  • Out of the box, ditac supports the so-called Extended Profile.
    This Extended Profile may be customized by the means of -p load.mdita.XXX parameters. These load.mdita.XXX parameters are documented below.

§ Limitations

  • Without a {.map} class attribute added to the title of an MDITA map, this map is confused with a topic.

§ load.mdita.XXX parameters

Parameter -p load.mdita.extended-profile true is implicitely passed to ditac. This parameter is simply a shorthand for:
-p load.mdita.abbreviation true
-p load.mdita.admonition true
-p load.mdita.attributes true
-p load.mdita.definition true
-p load.mdita.footnotes true
-p load.mdita.gfm-strikethrough true
-p load.mdita.ins true
-p load.mdita.superscript true
-p load.mdita.tables true
-p load.mdita.typographic true
-p load.mdita.yaml-front-matter true
where abbreviation, admonition, attributes, etc, are all Markdown extensions, documented in Markdown extensions.
If for example, you don’t like the stock Extended Profile and prefer to use a simpler one, plus the autolink Markdown extension(1), then pass:
-p load.mdita.core-profile true
-p load.mdita.autolink true
to ditac.
Parameter -p load.mdita.core-profile true is simply a shorthand for:
-p load.mdita.gfm-strikethrough true
-p load.mdita.superscript true
-p load.mdita.tables true
-p load.mdita.yaml-front-matter true
 (1) Turns plain text URLs and email addresses into <xref href="..."> elements.