dita2eclipsehelp.html 6.8 KB

123456789101112131415161718192021222324252627282930313233343536
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en-us"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="concept"><meta name="description" content="The eclipsehelp transformation generates XHTML output, CSS files, and the control files that are needed for Eclipse help."><meta name="DC.Relation" scheme="URI" content="../topics/output-formats.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-base.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-base-html.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-eclipsehelp.html"><meta name="DC.Relation" scheme="URI" content="../parameters/generate-copy-outer.html"><meta name="DC.Relation" scheme="URI" content="http://www.eclipse.org"><meta name="DC.Format" content="HTML5"><meta name="DC.Identifier" content="dita2eclipsehelp"><meta name="DC.Language" content="en-US"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Eclipse help</title></head><body id="dita2eclipsehelp"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.0</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a><ul><li><a href="../topics/build-using-dita-command.html">Using the dita command</a></li><li><a href="../topics/publishing-with-ant.html">Using Ant</a></li><li><a href="../topics/output-formats.html">Output formats</a><ul><li><a href="../topics/dita2pdf.html">PDF</a></li><li><a href="../topics/dita2html5.html">HTML5</a></li><li class="active"><a href="../topics/dita2eclipsehelp.html">Eclipse help</a></li><li><a href="../topics/dita2htmlhelp.html">HTML Help</a></li><li><a href="../topics/dita2markdown.html">Markdown</a></li><li><a href="../topics/dita2dita.html">Normalized DITA</a></li><li><a href="../topics/dita2tocjs.html">TocJS</a></li><li><a href="../topics/dita2troff.html">troff</a></li><li><a href="../topics/dita2xhtml.html">XHTML</a></li></ul></li></ul></li><li><a href="../parameters/index.html">Setting parameters</a></li><li><a href="../topics/extending-the-ot.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
  7. <h1 class="title topictitle1" id="ariaid-title1">Eclipse help</h1>
  8. <div class="body conbody"><p class="shortdesc">The <span class="keyword option">eclipsehelp</span> transformation generates XHTML output, CSS files, and the control files
  9. that are needed for Eclipse help.</p>
  10. <div class="p">In addition to the XHTML output and CSS files, this transformation returns the following files, where
  11. <var class="keyword varname">mapname</var> is the name of the master DITA map. <table class="simpletable frame-all"><colgroup><col style="width:40%"><col style="width:60%"></colgroup><thead><tr class="sthead">
  12. <th class="stentry" scope="col">File name</th>
  13. <th class="stentry" scope="col">Description</th>
  14. </tr></thead><tbody><tr class="strow">
  15. <td class="stentry"><span class="ph filepath">plugin.xml</span></td>
  16. <td class="stentry">Control file for the Eclipse plug-in</td>
  17. </tr><tr class="strow">
  18. <td class="stentry"><span class="ph filepath"><var class="keyword varname">mapname</var>.xml</span></td>
  19. <td class="stentry">Table of contents</td>
  20. </tr><tr class="strow">
  21. <td class="stentry"><span class="ph filepath">index.xml</span></td>
  22. <td class="stentry">Index file</td>
  23. </tr><tr class="strow">
  24. <td class="stentry"><span class="ph filepath">plugin.properties</span></td>
  25. <td class="stentry"></td>
  26. </tr><tr class="strow">
  27. <td class="stentry"><span class="ph filepath">META-INF/MANIFEST.MF</span></td>
  28. <td class="stentry"></td>
  29. </tr></tbody></table>
  30. </div>
  31. <p class="p">To run the Eclipse help transformation, set the <span class="keyword parmname">transtype</span> parameter to
  32. <span class="keyword option">eclipsehelp</span>, or pass the <span class="keyword parmname">--format</span>=<span class="keyword option">eclipsehelp</span> option to
  33. the <span class="keyword cmdname">dita</span> command line.</p>
  34. </div>
  35. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/output-formats.html" title="The DITA Open Toolkit ships with several core transformations that generate different output formats from DITA content. Each transformation represents an implementation of the processing that is defined by OASIS in the DITA specification.">DITA-OT transformations (output formats)</a></div></div><div class="linklist relinfo relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/generate-copy-outer.html" title="By default, DITA-OT assumes content is located in or beneath the directory containing the DITA map file. The generate.copy.outer parameter can be used to adjust how output is generated for content that is located outside the map directory.">Handling content outside the map directory</a></li></ul></div><div class="linklist relinfo relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.">Common parameters</a></li><li class="linklist"><a class="link" href="../parameters/parameters-base-html.html" title="Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, Eclipse help, and TocJS.">HTML-based output parameters</a></li><li class="linklist"><a class="link" href="../parameters/parameters-eclipsehelp.html" title="Certain parameters are specific to the Eclipse help transformation.">Eclipse Help parameters</a></li></ul></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="http://www.eclipse.org" target="_blank">Official Eclipse website</a></li></ul></div></nav></article></main></body></html>