dita2eclipsehelp.dita 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
  3. <!--This file is part of the DITA Open Toolkit project. See the accompanying LICENSE.md file for applicable licenses.-->
  4. <concept id="dita2eclipsehelp" xml:lang="en-US">
  5. <title>DITA to Eclipse help</title>
  6. <shortdesc>The <option>eclipsehelp</option> transformation generates XHTML output, CSS files, and the control files
  7. that are needed for Eclipse help.</shortdesc>
  8. <conbody>
  9. <p>In addition to the XHTML output and CSS files, this transformation returns the following files, where
  10. <varname>mapname</varname> is the name of the master DITA map. <simpletable frame="all" relcolwidth="2.0* 3.0*">
  11. <sthead>
  12. <stentry>File name</stentry>
  13. <stentry>Description</stentry>
  14. </sthead>
  15. <strow>
  16. <stentry><filepath>plugin.xml</filepath></stentry>
  17. <stentry>Control file for the Eclipse plug-in</stentry>
  18. </strow>
  19. <strow>
  20. <stentry><filepath><varname>mapname</varname>.xml</filepath></stentry>
  21. <stentry>Table of contents</stentry>
  22. </strow>
  23. <strow>
  24. <stentry><filepath>index.xml</filepath></stentry>
  25. <stentry>Index file</stentry>
  26. </strow>
  27. <strow>
  28. <stentry><filepath>plugin.properties</filepath></stentry>
  29. <stentry/>
  30. </strow>
  31. <strow>
  32. <stentry><filepath>META-INF/MANIFEST.MF</filepath></stentry>
  33. <stentry/>
  34. </strow>
  35. </simpletable></p>
  36. <draft-comment>RDA> The following paragraph correctly describes the Eclipse Help specialization, but I'm keeping it
  37. out until we have more complete documentation. I'd like to get more complete docs on this into an upcoming milestone.
  38. <p>For more complex plug-ins, the <filepath>plugins</filepath> directory in the DITA-OT contains an "Eclipse Map"
  39. specialization that gives more control over the generated <filepath>plugin.xml</filepath> file. The
  40. specialization provides additional control over metadata, as well as the ability to reference multiple TOC
  41. files, index files, and other Eclipse extensions.</p></draft-comment>
  42. <p>To run the Eclipse help transformation, set the <parmname>transtype</parmname> parameter to
  43. <option>eclipsehelp</option>, or pass the <option>-format eclipsehelp</option> option to the
  44. <cmdname>dita</cmdname> command line.</p>
  45. </conbody>
  46. </concept>