dita2eclipsehelp.dita 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  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. <prolog>
  9. <metadata>
  10. <keywords>
  11. <indexterm>transformations<indexterm>Eclipse Help</indexterm></indexterm>
  12. <indexterm>Eclipse Help<index-see-also>transformations</index-see-also></indexterm>
  13. <indexterm>plug-ins<indexterm>dita2eclipsehelp</indexterm></indexterm>
  14. <indexterm>dita2eclipsehelp</indexterm>
  15. <indexterm>CSS<indexterm>Eclipse Help</indexterm></indexterm>
  16. <indexterm>table of contents<indexterm>Eclipse Help</indexterm></indexterm>
  17. </keywords>
  18. </metadata>
  19. </prolog>
  20. <conbody>
  21. <p>In addition to the XHTML output and CSS files, this transformation returns the following files, where
  22. <varname>mapname</varname> is the name of the master DITA map.</p>
  23. <simpletable outputclass="table-hover" frame="all" relcolwidth="2* 3*">
  24. <sthead>
  25. <stentry>File name</stentry>
  26. <stentry>Description</stentry>
  27. </sthead>
  28. <strow>
  29. <stentry><filepath>plugin.xml</filepath></stentry>
  30. <stentry>Control file for the Eclipse plug-in</stentry>
  31. </strow>
  32. <strow>
  33. <stentry><filepath><varname>mapname</varname>.xml</filepath></stentry>
  34. <stentry>Table of contents</stentry>
  35. </strow>
  36. <strow>
  37. <stentry><filepath>index.xml</filepath></stentry>
  38. <stentry>Index file</stentry>
  39. </strow>
  40. <strow>
  41. <stentry><filepath>plugin.properties</filepath></stentry>
  42. <stentry/>
  43. </strow>
  44. <strow>
  45. <stentry><filepath>META-INF/MANIFEST.MF</filepath></stentry>
  46. <stentry/>
  47. </strow>
  48. </simpletable>
  49. <p>To run the Eclipse help transformation, set the <parmname>transtype</parmname> parameter to
  50. <option>eclipsehelp</option>, or pass the <parmname>--format</parmname>=<option>eclipsehelp</option> option to
  51. the <cmdname>dita</cmdname> command line.</p>
  52. <codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>eclipsehelp</option></codeblock>
  53. <p>where:</p>
  54. <ul>
  55. <li conref="../resources/conref-task.dita#ID/novice-variables-1"
  56. conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
  57. </ul>
  58. </conbody>
  59. </concept>