| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE html
|
|---|
| 3 | PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|
| 4 | <html xml:lang="en-us" lang="en-us">
|
|---|
| 5 | <head>
|
|---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|---|
| 7 | <meta name="copyright" content="(C) Copyright 2005"/>
|
|---|
| 8 | <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
|
|---|
| 9 | <meta name="DC.Type" content="concept"/>
|
|---|
| 10 | <meta name="DC.Title" content="Eclipse help processing"/>
|
|---|
| 11 | <meta name="abstract" content="The eclipsehelp transformation generates XHTML-based output and files that are needing to create an Eclipse Help system plug-in. Once the normal XHTML process has run, the dita.map.eclipse target is used to create a set of control files and navigation files."/>
|
|---|
| 12 | <meta name="description" content="The eclipsehelp transformation generates XHTML-based output and files that are needing to create an Eclipse Help system plug-in. Once the normal XHTML process has run, the dita.map.eclipse target is used to create a set of control files and navigation files."/>
|
|---|
| 13 | <meta name="DC.Relation" scheme="URI" content="../dev_ref/XhtmlWithNavigation.html"/>
|
|---|
| 14 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 15 | <meta name="DC.Identifier" content="xhtmleclipse"/>
|
|---|
| 16 | <meta name="DC.Language" content="en-us"/>
|
|---|
| 17 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 18 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 19 | <title>Eclipse help processing</title>
|
|---|
| 20 | </head>
|
|---|
| 21 | <body id="xhtmleclipse">
|
|---|
| 22 |
|
|---|
| 23 |
|
|---|
| 24 | <h1 class="title topictitle1">Eclipse help processing</h1>
|
|---|
| 25 |
|
|---|
| 26 |
|
|---|
| 27 | <div class="body conbody"><p class="shortdesc">The <span class="keyword option">eclipsehelp</span> transformation generates XHTML-based output and files
|
|---|
| 28 | that are needing to create an Eclipse Help system plug-in. Once the normal XHTML process has run,
|
|---|
| 29 | the <samp class="ph codeph">dita.map.eclipse</samp> target is used to create a set of control files and navigation
|
|---|
| 30 | files.</p>
|
|---|
| 31 |
|
|---|
| 32 | <div class="section"><div class="p">Eclipse use multiple files to control the plug-in behavior. Some of these control files are
|
|---|
| 33 | generated by the build, while others might be created manually. The following Ant targets control
|
|---|
| 34 | the Eclipse help processing:<dl class="dl">
|
|---|
| 35 |
|
|---|
| 36 | <dt class="dt dlterm"><samp class="ph codeph">dita.map.eclipse.init</samp></dt>
|
|---|
| 37 |
|
|---|
| 38 | <dd class="dd">Sets up various default properties</dd>
|
|---|
| 39 |
|
|---|
| 40 |
|
|---|
| 41 |
|
|---|
| 42 | <dt class="dt dlterm"><samp class="ph codeph">dita.map.eclipse.toc</samp></dt>
|
|---|
| 43 |
|
|---|
| 44 | <dd class="dd">Creates the XML file that defines an Eclipse table of contents</dd>
|
|---|
| 45 |
|
|---|
| 46 |
|
|---|
| 47 |
|
|---|
| 48 | <dt class="dt dlterm"><samp class="ph codeph">dita.map.eclipse.index</samp></dt>
|
|---|
| 49 |
|
|---|
| 50 | <dd class="dd">Creates the sorted XML file that defines an Eclipse index</dd>
|
|---|
| 51 |
|
|---|
| 52 |
|
|---|
| 53 |
|
|---|
| 54 | <dt class="dt dlterm"><samp class="ph codeph">dita.map.eclipse.plugin</samp></dt>
|
|---|
| 55 |
|
|---|
| 56 | <dd class="dd">Creates the <span class="ph filepath">plugin.xml</span> file that controls the behavior of an Eclipse
|
|---|
| 57 | plug-in</dd>
|
|---|
| 58 |
|
|---|
| 59 |
|
|---|
| 60 |
|
|---|
| 61 | <dt class="dt dlterm"><samp class="ph codeph">dita.map.eclipse.plugin.properties</samp></dt>
|
|---|
| 62 |
|
|---|
| 63 | <dd class="dd">Creates a Java properties file that sets properties for the plug-in, such as name and version
|
|---|
| 64 | information</dd>
|
|---|
| 65 |
|
|---|
| 66 |
|
|---|
| 67 |
|
|---|
| 68 | <dt class="dt dlterm"><samp class="ph codeph">dita.map.eclipse.manifest.file</samp></dt>
|
|---|
| 69 |
|
|---|
| 70 | <dd class="dd">Creates a <span class="ph filepath">MANIFEST.MF</span> file that contains additional information used by
|
|---|
| 71 | Eclipse</dd>
|
|---|
| 72 |
|
|---|
| 73 |
|
|---|
| 74 |
|
|---|
| 75 | <dt class="dt dlterm"><samp class="ph codeph">copy-plugin-files</samp></dt>
|
|---|
| 76 |
|
|---|
| 77 | <dd class="dd">Checks for the presence of certain control files in the source directory, and copies those found
|
|---|
| 78 | to the output directory</dd>
|
|---|
| 79 |
|
|---|
| 80 |
|
|---|
| 81 |
|
|---|
| 82 | <dt class="dt dlterm"><samp class="ph codeph">dita.map.eclipse.fragment.language.init</samp></dt>
|
|---|
| 83 |
|
|---|
| 84 | <dd class="dd">Works in conjunction with the <samp class="ph codeph">dita.map.eclipse.fragment.language.country.init</samp>
|
|---|
| 85 | and <samp class="ph codeph">dita.map.eclipse.fragment.error</samp> targets to control Eclipse fragment files,
|
|---|
| 86 | which are used for versions of a plug-in created for a new language or locale</dd>
|
|---|
| 87 |
|
|---|
| 88 |
|
|---|
| 89 | </dl>
|
|---|
| 90 | </div>
|
|---|
| 91 | <p class="p">Several of the targets listed above have matching templates for processing content that is
|
|---|
| 92 | located outside of the scope of the map directory, such as
|
|---|
| 93 | <samp class="ph codeph">dita.out.map.eclipse.toc</samp>.</p>
|
|---|
| 94 | </div>
|
|---|
| 95 |
|
|---|
| 96 | </div>
|
|---|
| 97 |
|
|---|
| 98 | <div class="related-links">
|
|---|
| 99 | <div class="familylinks">
|
|---|
| 100 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/XhtmlWithNavigation.html" title="The DITA-OT ships with several varieties of XHTML output, each of which follows roughly the same path through the processing pipeline. All XHTML-based transformation begin with the same call to the pre-processing module, after which they generate XHTML files and then branch to create the transformation-specific navigation files.">XHTML processing modules</a></div>
|
|---|
| 101 | </div>
|
|---|
| 102 | </div>
|
|---|
| 103 |
|
|---|
| 104 | </body>
|
|---|
| 105 | </html>
|
|---|
