| 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="reference"/>
|
|---|
| 10 | <meta name="DC.Title" content="Ant parameters: Eclipse help transformation"/>
|
|---|
| 11 | <meta name="abstract" content="Certain parameters are specific to the Eclipse help transformation."/>
|
|---|
| 12 | <meta name="description" content="Certain parameters are specific to the Eclipse help transformation."/>
|
|---|
| 13 | <meta name="DC.subject" content="Ant, parameters, args.eclipsehelp.toc, args.eclipse.country, args.eclipse.language, args.eclipse.provider, args.eclipse.version, args.eclipse.symbolic.name"/>
|
|---|
| 14 | <meta name="keywords" content="Ant, parameters, args.eclipsehelp.toc, args.eclipse.country, args.eclipse.language, args.eclipse.provider, args.eclipse.version, args.eclipse.symbolic.name"/>
|
|---|
| 15 | <meta name="DC.Relation" scheme="URI" content="../readme/dita-ot_ant_properties.html"/>
|
|---|
| 16 | <meta name="DC.Relation" scheme="URI" content="../readme/dita2eclipsehelp.html"/>
|
|---|
| 17 | <meta name="DC.Relation" scheme="URI" content="../readme/ant-parameters-all-transformation-types.html"/>
|
|---|
| 18 | <meta name="DC.Relation" scheme="URI" content="../readme/ant-parameters-common-html-transtypes.html"/>
|
|---|
| 19 | <meta name="DC.Relation" scheme="URI" content="../readme/ant-parameters-common-html-transtypes.html"/>
|
|---|
| 20 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 21 | <meta name="DC.Identifier" content="ant-parameters-eclipse-help-transformation.dita"/>
|
|---|
| 22 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 23 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 24 | <title>Ant parameters: Eclipse help transformation</title>
|
|---|
| 25 | </head>
|
|---|
| 26 | <body id="ant-parameters-eclipse-help-transformation.dita">
|
|---|
| 27 |
|
|---|
| 28 |
|
|---|
| 29 | <h1 class="title topictitle1">Ant parameters: Eclipse help transformation</h1>
|
|---|
| 30 |
|
|---|
| 31 |
|
|---|
| 32 |
|
|---|
| 33 |
|
|---|
| 34 | <div class="body refbody"><p class="shortdesc">Certain parameters are specific to the Eclipse help transformation.</p>
|
|---|
| 35 |
|
|---|
| 36 |
|
|---|
| 37 | <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="table" frame="border" border="1" rules="all"><caption><span class="tablecap">Table 1. Ant parameters: Eclipse help transformation</span></caption>
|
|---|
| 38 |
|
|---|
| 39 |
|
|---|
| 40 | <thead class="thead" align="left">
|
|---|
| 41 | <tr class="row">
|
|---|
| 42 | <th class="entry" valign="top" width="27.27272727272727%" id="d26133e62">Parameters</th>
|
|---|
| 43 |
|
|---|
| 44 | <th class="entry" valign="top" width="72.72727272727273%" id="d26133e65">Description</th>
|
|---|
| 45 |
|
|---|
| 46 | </tr>
|
|---|
| 47 |
|
|---|
| 48 | </thead>
|
|---|
| 49 |
|
|---|
| 50 | <tbody class="tbody">
|
|---|
| 51 | <tr id="ant-parameters-eclipse-help-transformation.dita__args.eclipsehelp.toc" class="row">
|
|---|
| 52 | <td class="entry" valign="top" width="27.27272727272727%" headers="d26133e62 "><span class="keyword parmname">args.eclipsehelp.toc</span></td>
|
|---|
| 53 |
|
|---|
| 54 | <td class="entry" id="ant-parameters-eclipse-help-transformation.dita__args.eclipsehelp.toc.desc" valign="top" width="72.72727272727273%" headers="d26133e65 ">Specifies the name of the TOC file.</td>
|
|---|
| 55 |
|
|---|
| 56 | </tr>
|
|---|
| 57 |
|
|---|
| 58 | <tr id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.country" class="row">
|
|---|
| 59 | <td class="entry" valign="top" width="27.27272727272727%" headers="d26133e62 "><span class="keyword parmname">args.eclipse.country</span></td>
|
|---|
| 60 |
|
|---|
| 61 | <td class="entry" id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.country.desc" valign="top" width="72.72727272727273%" headers="d26133e65 ">Specifies the region for the language that is
|
|---|
| 62 | specified by the <span class="keyword parmname">args.eclipse.language</span> parameter. For example,
|
|---|
| 63 | <span class="keyword option">us</span>, <span class="keyword option">ca</span>, and <span class="keyword option">gb</span> would clarify a
|
|---|
| 64 | value of <span class="keyword option">en</span> set for the <span class="keyword parmname">args.eclipse.language</span>
|
|---|
| 65 | parameter. The content will be moved into the appropriate directory structure for an
|
|---|
| 66 | Eclipse fragment.</td>
|
|---|
| 67 |
|
|---|
| 68 | </tr>
|
|---|
| 69 |
|
|---|
| 70 | <tr id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.language" class="row">
|
|---|
| 71 | <td class="entry" valign="top" width="27.27272727272727%" headers="d26133e62 "><span class="keyword parmname">args.eclipse.language</span></td>
|
|---|
| 72 |
|
|---|
| 73 | <td class="entry" id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.language.desc" valign="top" width="72.72727272727273%" headers="d26133e65 ">Specifies the base language for translated
|
|---|
| 74 | content, such as <span class="keyword option">en</span> for English. This parameter is a prerequisite for
|
|---|
| 75 | the <span class="keyword parmname">args.eclipse.country</span> parameter. The content will be moved
|
|---|
| 76 | into the appropriate directory structure for an Eclipse fragment.</td>
|
|---|
| 77 |
|
|---|
| 78 | </tr>
|
|---|
| 79 |
|
|---|
| 80 | <tr id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.provider" class="row">
|
|---|
| 81 | <td class="entry" valign="top" width="27.27272727272727%" headers="d26133e62 "><span class="keyword parmname">args.eclipse.provider</span></td>
|
|---|
| 82 |
|
|---|
| 83 | <td class="entry" id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.provider.desc" valign="top" width="72.72727272727273%" headers="d26133e65 ">Specifies the name of the person or organization
|
|---|
| 84 | that provides the Eclipse help. The default value is <span class="keyword option">DITA</span>. <div class="note tip"><span class="tiptitle">Tip:</span> The toolkit ignores the value of this parameter when it processes an
|
|---|
| 85 | Eclipse map.</div>
|
|---|
| 86 |
|
|---|
| 87 | </td>
|
|---|
| 88 |
|
|---|
| 89 | </tr>
|
|---|
| 90 |
|
|---|
| 91 | <tr id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.version" class="row">
|
|---|
| 92 | <td class="entry" valign="top" width="27.27272727272727%" headers="d26133e62 "><span class="keyword parmname">args.eclipse.version</span></td>
|
|---|
| 93 |
|
|---|
| 94 | <td class="entry" id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.version.desc" valign="top" width="72.72727272727273%" headers="d26133e65 ">Specifies the version number to include in the
|
|---|
| 95 | output. The default value is <span class="keyword option">0.0.0</span>.<div class="note tip"><span class="tiptitle">Tip:</span> The toolkit
|
|---|
| 96 | ignores the value of this parameter when it processes an Eclipse map.</div>
|
|---|
| 97 | </td>
|
|---|
| 98 |
|
|---|
| 99 | </tr>
|
|---|
| 100 |
|
|---|
| 101 | <tr id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.symbolic.name" class="row">
|
|---|
| 102 | <td class="entry" valign="top" width="27.27272727272727%" headers="d26133e62 "><span class="keyword parmname">args.eclipse.symbolic.name</span></td>
|
|---|
| 103 |
|
|---|
| 104 | <td class="entry" id="ant-parameters-eclipse-help-transformation.dita__args.eclipse.symbolic.name.desc" valign="top" width="72.72727272727273%" headers="d26133e65 "> Specifies the symbolic name (aka plugin ID)
|
|---|
| 105 | in the output for an Eclipse Help project. The @id value from the DITA map or the
|
|---|
| 106 | Eclipse map collection (Eclipse help specialization) is the symbolic name for the
|
|---|
| 107 | plugin in Eclipse. The default value is <span class="keyword option">org.sample.help.doc</span>.<div class="note tip"><span class="tiptitle">Tip:</span> The toolkit ignores the value of this parameter when it processes an
|
|---|
| 108 | Eclipse map.</div>
|
|---|
| 109 | </td>
|
|---|
| 110 |
|
|---|
| 111 | </tr>
|
|---|
| 112 |
|
|---|
| 113 | </tbody>
|
|---|
| 114 |
|
|---|
| 115 | </table>
|
|---|
| 116 | </div>
|
|---|
| 117 |
|
|---|
| 118 | </div>
|
|---|
| 119 |
|
|---|
| 120 | <div class="related-links">
|
|---|
| 121 | <div class="familylinks">
|
|---|
| 122 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../readme/dita-ot_ant_properties.html" title="Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based transformations. Finally, some parameters apply only to the specific transformation types.">Ant parameters</a></div>
|
|---|
| 123 | </div>
|
|---|
| 124 | <div class="relinfo relconcepts"><strong>Related concepts</strong><br/>
|
|---|
| 125 | <div><a class="link" href="../readme/dita2eclipsehelp.html" title="The eclipsehelp transformation generates XHTML output, CSS files, and the control files that are needed for Eclipse help.">Eclipse help transformation</a></div>
|
|---|
| 126 | </div>
|
|---|
| 127 | <div class="relinfo relref"><strong>Related reference</strong><br/>
|
|---|
| 128 | <div><a class="link" href="../readme/ant-parameters-all-transformation-types.html" title="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.">Ant parameters: All transformations</a></div>
|
|---|
| 129 | <div><a class="link" href="../readme/ant-parameters-common-html-transtypes.html" title="Certain parameters apply to all the HTML-based transformation types: Eclipse content, Eclipse help, HTML Help, JavaHelp, TocJS, and XHTML.">Ant parameters: Common HTML-based transformations</a></div>
|
|---|
| 130 | </div>
|
|---|
| 131 | </div>
|
|---|
| 132 |
|
|---|
| 133 | </body>
|
|---|
| 134 | </html>
|
|---|
