lwdita-input.html 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2019"><meta name="DC.rights.owner" content="(C) Copyright 2019"><meta name="DC.type" content="topic"><meta name="description" content="DITA-OT provides preview support for the authoring formats proposed for Lightweight DITA, or “LwDITA”. The XDITA, MDITA and HDITA formats are alternative representations of DITA content in XML, Markdown and HTML5."><meta name="DC.subject" content=", topicref, format, authoring formats, Lightweight DITA, metadata, DITA 1.3"><meta name="keywords" content=", topicref, format, authoring formats, Lightweight DITA, metadata, DITA 1.3"><meta name="DC.relation" scheme="URI" content="../topics/alternative-input-formats.html"><meta name="DC.relation" scheme="URI" content="../topics/markdown-input.html"><meta name="DC.relation" scheme="URI" content="../topics/markdown-dita-syntax-reference.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="lwdita-input"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Preview support for Lightweight DITA</title></head><body id="lwdita-input"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a><ul><li><a href="../topics/markdown-input.html">Markdown content</a></li><li class="active"><a href="../topics/lwdita-input.html">Lightweight DITA</a></li><li><a href="../topics/markdown-dita-syntax-reference.html">Markdown DITA syntax</a></li></ul></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a></li><li><a href="../topics/customizing.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
  7. <h1 class="title topictitle1" id="ariaid-title1">Preview support for Lightweight DITA</h1>
  8. <div class="body"><p class="shortdesc">DITA-OT provides preview support for the authoring formats proposed for
  9. <a class="xref" href="http://docs.oasis-open.org/dita/LwDITA/v1.0/cn01/LwDITA-v1.0-cn01.pdf" target="_blank">Lightweight DITA</a>, or “<dfn class="term">LwDITA</dfn>”. The XDITA, MDITA and HDITA formats are alternative
  10. representations of DITA content in XML, Markdown and HTML5.</p>
  11. <div class="note attention note_attention"><span class="note__title">Attention:</span> Since
  12. <a class="xref" href="http://docs.oasis-open.org/dita/LwDITA/v1.0/cn01/LwDITA-v1.0-cn01.pdf" target="_blank">Lightweight DITA</a> has not yet been released as a formal specification, the implementation for XDITA, MDITA
  13. and HDITA authoring formats is subject to change. Future versions of DITA Open Toolkit will be updated as LwDITA
  14. evolves.</div>
  15. <section class="section"><h2 class="title sectiontitle">XDITA</h2>
  16. <p class="p">XDITA is the LwDITA authoring format that uses XML to structure information. XDITA is a subset of DITA, with
  17. new multimedia element types added to support interoperability with HTML5. XDITA is designed for users who want
  18. to write DITA content but who do not want (or need) the full power of DITA.</p>
  19. <p class="p">The XDITA parser included in the <code class="ph codeph">org.lwdita</code> plug-in provides preliminary support for XDITA
  20. maps and XDITA topics.</p>
  21. <p class="p">To apply XDITA-specific processing to topics in an XDITA map or a full DITA 1.3 map, set the
  22. <code class="keyword markupname xmlatt">@format</code> attribute on a <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> to <code class="ph codeph">xdita</code>:</p>
  23. <div class="p">
  24. <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;map&gt;
  25. &lt;topicref href="xdita-topic.xml" <strong class="ph b">format="xdita"</strong>/&gt;
  26. &lt;/map&gt;</code></pre>
  27. </div>
  28. <div class="note tip note_tip"><span class="note__title">Tip:</span> For examples of cross-format content sharing between topics in XDITA, HDITA, extended-profile
  29. MDITA, and DITA 1.3, see the LwDITA sample files in the DITA-OT installation directory under
  30. <span class="ph filepath">plugins/org.oasis-open.xdita.v0_2_2/samples</span>.</div>
  31. </section>
  32. <section class="section"><h2 class="title sectiontitle">MDITA</h2>
  33. <p class="p">MDITA is the LwDITA authoring format based on Markdown. It is designed for users who want to write structured
  34. content with the minimum of overhead, but who also want to take advantage of the reuse mechanisms associated
  35. with the DITA standard and the multi-channel publishing afforded by standard DITA tooling.</p>
  36. <p class="p">Recent proposals for LwDITA include two profiles for authoring MDITA topics:</p>
  37. <ul class="ul">
  38. <li class="li">The “<dfn class="term">Core profile</dfn>” is based on
  39. <a class="xref" href="https://github.github.com/gfm/" target="_blank">GitHub-Flavored Markdown</a> and includes elements that are common to many other Markdown implementations.</li>
  40. <li class="li">The “<dfn class="term">Extended profile</dfn>” borrows additional features from other flavors of Markdown to represent
  41. a broader range of DITA content with existing plain-text syntax conventions.</li>
  42. </ul>
  43. <p class="p">The Markdown DITA parser included in the <code class="ph codeph">org.lwdita</code> plug-in provides preliminary support for
  44. these profiles and additional Markdown constructs as described in the syntax reference.</p>
  45. <p class="p">To apply LwDITA-specific processing to Markdown topics, set the <code class="keyword markupname xmlatt">@format</code> attribute to
  46. <code class="ph codeph">mdita</code>:</p>
  47. <div class="p">
  48. <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;map&gt;
  49. &lt;topicref href="mdita-topic.md" <strong class="ph b">format="mdita"</strong>/&gt;
  50. &lt;/map&gt;</code></pre>
  51. </div>
  52. <p class="p">In this case, the first paragraph in the topic will be treated as a short description, for example, and
  53. additional metadata can be specified for the topic via a YAML front matter block.</p>
  54. <div class="note note note_note"><span class="note__title">Note:</span> Setting the <code class="keyword markupname xmlatt">@format</code> attribute to <code class="ph codeph">mdita</code> triggers stricter parsing than the
  55. more lenient document parsing approach that is applied to <code class="ph codeph">markdown</code> documents.</div>
  56. <div class="note attention note_attention"><span class="note__title">Attention:</span> The MDITA map format is not yet supported. To include Markdown content in publications, use
  57. an XDITA map or a DITA 1.3 map.</div>
  58. </section>
  59. <section class="section"><h2 class="title sectiontitle">HDITA</h2>
  60. <p class="p">HDITA is the LwDITA authoring format based on HTML5, which is intended to support structured content authoring
  61. with tools designed for HTML authoring. HDITA also uses custom data attributes to provide interoperability with
  62. DITA.</p>
  63. <p class="p">The HDITA parser included in the <code class="ph codeph">org.lwdita</code> plug-in provides preliminary support for these
  64. constructs.</p>
  65. <p class="p">To apply LwDITA-specific processing to HTML topics, set the <code class="keyword markupname xmlatt">@format</code> attribute to
  66. <code class="ph codeph">hdita</code>:</p>
  67. <div class="p">
  68. <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;map&gt;
  69. &lt;topicref href="hdita-topic.html" <strong class="ph b">format="hdita"</strong>/&gt;
  70. &lt;/map&gt;</code></pre>
  71. </div>
  72. <div class="note attention note_attention"><span class="note__title">Attention:</span> The HDITA map format is not yet supported. To include HDITA content, use an XDITA map or a
  73. DITA 1.3 map.</div>
  74. </section>
  75. </div>
  76. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/alternative-input-formats.html" title="DITA-OT³ supports several alternative input formats in addition to standard DITA XML, including Markdown and the proposed XDITA, MDITA and HDITA authoring formats currently in development for Lightweight DITA.">Alternative authoring formats</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/markdown-input.html" title="Markdown is a lightweight markup language that allows you to write using an easy-to-read plain text format and convert to structurally valid markup as necessary.">Markdown content</a></li><li class="linklist"><a class="link" href="../topics/markdown-dita-syntax-reference.html" title="Markdown DITA uses CommonMark as the underlying markup language.">Markdown DITA syntax reference</a></li></ul></div></nav></article></main></body></html>