Accueil Explorer Aide
Connexion
bn
/
se
2
0
Fork 0
Fichiers Tickets 0 Pull Requests 0 Wiki
Aborescence: aa0af5da67
Branches Tags
se
/
SE
/
schema
/
WPS_Functions
/
dita-ot
/
dita-ot-3.0.4
/
doc
/
topics
/
lwdita-input.html

lwdita-input.html 7.1 KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960 
  1. <!DOCTYPE html
    2. 

  2.   SYSTEM "about:legacy-compat">
    3. 

  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 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="topic"><meta name="description" content="DITA-OT provides preview support for the MDITA and HDITA authoring formats proposed for Lightweight DITA, or “LwDITA”. These proposed formats are alternative representations of DITA content in Markdown or HTML."><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. 

  4.   <p>DITA Open Toolkit</p>
    5. 

  5.   <hr>
    6. 

  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.0</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/extending-the-ot.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. 

  7.   <h1 class="title topictitle1" id="ariaid-title1">Preview support for Lightweight DITA</h1>
    8. 

  8.   
    9. 

  9.   
    10. 

  10. 

  11.   <div class="body"><p class="shortdesc">DITA-OT provides preview support for the MDITA and HDITA authoring formats proposed for
    12. 

  12.     <a class="xref" href="http://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.pdf" target="_blank">Lightweight DITA</a>, or “<dfn class="term">LwDITA</dfn>”. These proposed formats are alternative representations of DITA
    13. 

  13.     content in Markdown or HTML.</p>
    14. 

  14.     <section class="section"><h2 class="title sectiontitle">MDITA</h2>
    15. 

  15.       
    16. 

  16.       <p class="p">MDITA is the LwDITA authoring format based on Markdown.</p>
    17. 

  17.       <p class="p">Recent proposals for LwDITA include two profiles for authoring MDITA topics:</p>
    18. 

  18.       <ul class="ul">
    19. 

  19.         <li class="li">The “<dfn class="term">Core profile</dfn>” is based on <a class="xref" href="https://github.github.com/gfm/" target="_blank">GitHub-Flavored Markdown</a> and includes elements that are common
    20. 

  20.           to many other Markdown implementations.</li>
    21. 

  21.         <li class="li">The “<dfn class="term">Extended profile</dfn>” borrows additional features from other flavors of Markdown to represent
    22. 

  22.           a broader range of DITA content with existing plain-text syntax conventions.</li>
    23. 

  23.       </ul>
    24. 

  24.       <p class="p">The Markdown DITA parser included in the <code class="ph codeph">org.lwdita</code> plug-in provides preliminary support for
    25. 

  25.         these profiles and additional Markdown constructs as described in the syntax reference.</p>
    26. 

  26.       <p class="p">The <code class="keyword markupname xmlatt">@format</code> attribute can be set to <code class="ph codeph">mdita</code> to apply LwDITA-specific processing
    27. 

  27.         to Markdown topics:</p>
    28. 

  28.       <div class="p">
    29. 

  29.         <pre class="pre codeblock"><code>&lt;map&gt;
    30. 

  30.   &lt;topicref href="mdita-topic.md" <strong class="ph b">format="mdita"</strong>/&gt;
    31. 

  31. &lt;/map&gt;</code></pre>
    32. 

  32.       </div>
    33. 

  33.       <p class="p">In this case, the first paragraph in the topic will be treated as a short description, for example, and
    34. 

  34.         additional metadata can be specified for the topic via a YAML front matter block.</p>
    35. 

  35.       <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
    36. 

  36.         more lenient document parsing approach that is applied to <code class="ph codeph">markdown</code> documents.</div>
    37. 

  37.     </section>
    38. 

  38. 

  39.     <section class="section"><h2 class="title sectiontitle">HDITA</h2>
    40. 

  40.       
    41. 

  41.       <p class="p">HDITA is the LwDITA authoring format based on HTML5, which is intended to support structured content authoring
    42. 

  42.         with tools designed for HTML authoring. HDITA also uses custom data attributes to provide interoperability with
    43. 

  43.         DITA.</p>
    44. 

  44.       <p class="p">The HDITA parser included in the <code class="ph codeph">org.lwdita</code> plug-in provides preliminary support for these
    45. 

  45.         constructs.</p>
    46. 

  46.       <p class="p">The <code class="keyword markupname xmlatt">@format</code> attribute can be set to <code class="ph codeph">hdita</code> to apply LwDITA-specific processing
    47. 

  47.         to HTML topics:</p>
    48. 

  48.       <div class="p">
    49. 

  49.         <pre class="pre codeblock"><code>&lt;map&gt;
    50. 

  50.   &lt;topicref href="hdita-topic.html" <strong class="ph b">format="hdita"</strong>/&gt;
    51. 

  51. &lt;/map&gt;</code></pre>
    52. 

  52.       </div>
    53. 

  53.     </section>
    54. 

  54. 

  55.     <div class="note attention note_attention"><span class="note__title">Attention:</span> Since
    56. 

  56.       <a class="xref" href="http://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.pdf" target="_blank">Lightweight DITA</a> has not yet been released as a formal specification, the implementation for MDITA and
    57. 

  57.       HDITA authoring formats is subject to change. Future versions of DITA Open Toolkit will be updated as LwDITA
    58. 

  58.       evolves.</div>
    59. 

  59.   </div>
    60. 

  60. <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="As of release 3.0, DITA-OT supports several alternative input formats in addition to standard DITA XML, including Markdown and the proposed 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>
    61.