XhtmlEclipse.dita 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  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<indexterm>Eclipse Help</indexterm></indexterm>
  13. <indexterm>dita.map.eclipse</indexterm>
  14. <indexterm>Eclipse Help</indexterm>
  15. <indexterm>targets<indexterm>Eclipse Help</indexterm></indexterm>
  16. <indexterm>index<indexterm>Eclipse Help</indexterm></indexterm>
  17. <indexterm>table of contents<indexterm>Eclipse Help</indexterm></indexterm>
  18. </keywords>
  19. </metadata>
  20. </prolog>
  21. <conbody>
  22. <section>
  23. <p>Eclipse uses multiple files to control the plug-in behavior. Some of these control files are generated by the
  24. build, while others might be created manually. The following Ant targets control the Eclipse help
  25. processing:</p>
  26. <p>
  27. <dl>
  28. <dlentry>
  29. <dt><codeph>dita.map.eclipse.init</codeph></dt>
  30. <dd>Sets up various default properties</dd>
  31. </dlentry>
  32. <dlentry>
  33. <dt><codeph>dita.map.eclipse.toc</codeph></dt>
  34. <dd>Creates the XML file that defines an Eclipse table of contents</dd>
  35. </dlentry>
  36. <dlentry>
  37. <dt><codeph>dita.map.eclipse.index</codeph></dt>
  38. <dd>Creates the sorted XML file that defines an Eclipse index</dd>
  39. </dlentry>
  40. <dlentry>
  41. <dt><codeph>dita.map.eclipse.plugin</codeph></dt>
  42. <dd>Creates the <filepath>plugin.xml</filepath> file that controls the behavior of an Eclipse plug-in</dd>
  43. </dlentry>
  44. <dlentry>
  45. <dt><codeph>dita.map.eclipse.plugin.properties</codeph></dt>
  46. <dd>Creates a Java properties file that sets properties for the plug-in, such as name and version
  47. information</dd>
  48. </dlentry>
  49. <dlentry>
  50. <dt><codeph>dita.map.eclipse.manifest.file</codeph></dt>
  51. <dd>Creates a <filepath>MANIFEST.MF</filepath> file that contains additional information used by
  52. Eclipse</dd>
  53. </dlentry>
  54. <dlentry>
  55. <dt><codeph>copy-plugin-files</codeph></dt>
  56. <dd>Checks for the presence of certain control files in the source directory, and copies those found to the
  57. output directory</dd>
  58. </dlentry>
  59. <dlentry>
  60. <dt><codeph>dita.map.eclipse.fragment.language.init</codeph></dt>
  61. <dd>Works in conjunction with the <codeph>dita.map.eclipse.fragment.language.country.init</codeph> and
  62. <codeph>dita.map.eclipse.fragment.error</codeph> targets to control Eclipse fragment files, which are
  63. used for versions of a plug-in created for a new language or locale</dd>
  64. </dlentry>
  65. </dl>
  66. </p>
  67. <p>Several of the targets listed above have matching templates for processing content that is located outside of
  68. the scope of the map directory, such as <codeph>dita.out.map.eclipse.toc</codeph>.</p>
  69. </section>
  70. </conbody>
  71. </concept>