dita2eclipsehelp.dita 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  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 file for applicable license. -->
  4. <concept id="dita2eclipsehelp" xml:lang="en-US">
  5. <title>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>
  36. </p>
  37. <p>To run the Eclipse help transformation, set the <parmname>transtype</parmname> parameter to
  38. <option>eclipsehelp</option>, or pass the <parmname>--format</parmname>=<option>eclipsehelp</option> option to
  39. the <cmdname>dita</cmdname> command line.</p>
  40. </conbody>
  41. </concept>