eclipsehelp-processing.dita 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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="xhtmleclipse" xml:lang="en-US">
  5. <title>Eclipse help processing</title>
  6. <shortdesc>The <option>eclipsehelp</option> transformation generates XHTML-based output and files that are needed to
  7. create an Eclipse Help system plug-in. Once the normal XHTML process has run, the <codeph>dita.map.eclipse</codeph>
  8. target is used to create a set of control files and navigation files.</shortdesc>
  9. <prolog>
  10. <metadata>
  11. <keywords>
  12. <indexterm>HTML
  13. <indexterm>Eclipse Help</indexterm></indexterm>
  14. <indexterm>dita.map.eclipse</indexterm>
  15. <indexterm>Eclipse Help</indexterm>
  16. <indexterm>targets
  17. <indexterm>Eclipse Help</indexterm></indexterm>
  18. <indexterm>index
  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. <section>
  27. <p>Eclipse uses multiple files to control the plug-in behavior. Some of these control files are generated by the
  28. build, while others might be created manually. The following Ant targets control the Eclipse help
  29. processing:</p>
  30. <p>
  31. <dl>
  32. <dlentry>
  33. <dt><codeph>dita.map.eclipse.init</codeph></dt>
  34. <dd>Sets up various default properties</dd>
  35. </dlentry>
  36. <dlentry>
  37. <dt><codeph>dita.map.eclipse.toc</codeph></dt>
  38. <dd>Creates the XML file that defines an Eclipse table of contents</dd>
  39. </dlentry>
  40. <dlentry>
  41. <dt><codeph>dita.map.eclipse.index</codeph></dt>
  42. <dd>Creates the sorted XML file that defines an Eclipse index</dd>
  43. </dlentry>
  44. <dlentry>
  45. <dt><codeph>dita.map.eclipse.plugin</codeph></dt>
  46. <dd>Creates the <filepath>plugin.xml</filepath> file that controls the behavior of an Eclipse plug-in</dd>
  47. </dlentry>
  48. <dlentry>
  49. <dt><codeph>dita.map.eclipse.plugin.properties</codeph></dt>
  50. <dd>Creates a Java properties file that sets properties for the plug-in, such as name and version
  51. information</dd>
  52. </dlentry>
  53. <dlentry>
  54. <dt><codeph>dita.map.eclipse.manifest.file</codeph></dt>
  55. <dd>Creates a <filepath>MANIFEST.MF</filepath> file that contains additional information used by
  56. Eclipse</dd>
  57. </dlentry>
  58. <dlentry>
  59. <dt><codeph>copy-plugin-files</codeph></dt>
  60. <dd>Checks for the presence of certain control files in the source directory, and copies those found to the
  61. output directory</dd>
  62. </dlentry>
  63. <dlentry>
  64. <dt><codeph>dita.map.eclipse.fragment.language.init</codeph></dt>
  65. <dd>Works in conjunction with the <codeph>dita.map.eclipse.fragment.language.country.init</codeph> and
  66. <codeph>dita.map.eclipse.fragment.error</codeph> targets to control Eclipse fragment files, which are
  67. used for versions of a plug-in created for a new language or locale</dd>
  68. </dlentry>
  69. </dl>
  70. </p>
  71. <p>Several of the targets listed above have matching templates for processing content that is located outside of
  72. the scope of the map directory, such as <codeph>dita.out.map.eclipse.toc</codeph>.</p>
  73. </section>
  74. </conbody>
  75. </concept>