dita2eclipsehelp.dita 2.7 KB

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