blob: 3512288743b014e70a9a0d64efb69cf914d7d8f4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Feature Export</title>
<script language="JavaScript" type="text/javascript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
<link href="../../book.css" rel="stylesheet" type="text/css">
<style type="text/css">
<!--
.style1 {
font-size: 18px;
font-weight: bold;
}
.style2 {
font-size: 12pt;
font-weight: bold;
}
-->
</style>
</head>
<body>
<p class="style1">Feature Export</p>
<p>PDE provides a <strong>Feature Export</strong> wizard to export features and constituent plug-ins and fragments into a form that is suitable for deployment. The wizard shields you from Ant scripts and does not pollute your workspace with resources generated during the build operation. The wizard is available under <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.file.export(exportWizardId=org.eclipse.pde.ui.featureExportWizard)")'>
<img src="PLUGINS_ROOT/org.eclipse.help/command_link.png">
<strong>File &gt; Export... &gt; Plug-in Development &gt; Deployable features</strong>
</a>. </p>
<p>&nbsp;</p>
<p class="style2">Feature Selection </p>
<p>The wizard displays all the non-binary features found in the workspace. </p>
<p><img src="../../images/export_wizards/feature_available.png" alt="Feature Selection" hspace="30"></p>
<p>Select the features that you want to export. If you find yourself exporting the same set of features over and over, you can press <strong>Working Set...</strong> to define a <em> working set</em>. </p>
<p>Features are built recursively; therefore, in the case where one feature includes another feature, only the top-level feature needs to be selected in order to export them both.
</p>
<p>&nbsp;</p>
<p class="style2">Destination</p>
<p>You can choose to export the features and their constituent plug-ins to a directory or to a ZIP archive. </p>
<p><img src="../../images/export_wizards/destination_features.png" alt="Destination" hspace="30"></p>
<p>If you choose to export to a <strong>Directory</strong> (the default), the features will be placed in a <em>features/</em> subdirectory and the plug-ins will be placed in a <em>plugins/</em> subdirectory of the chosen directory.</p>
<p>If you choose to export to an <strong>Archive file</strong>, all of the features and plug-ins will be packaged into a single ZIP archive. Also, the root directory structure inside the ZIP starts with <em>features/</em> and <em>plugins/</em>. </p>
<p>&nbsp;</p>
<p class="style2">Options</p>
<p><img src="../../images/export_wizards/options_features.png" alt="Options" hspace="30"></p>
<p>The <strong>Include source code</strong> option results in the exporting of source code as well as binaries. If a plug-in is packaged as a JAR, the source code will be placed in a <em>src/</em> folder at the root of the JAR. If the plug-in is packaged as a flat directory, the source code will be placed in a source ZIP inside the plug-in directory as a sibling to the library JAR. Refer to the <a href="../preference_pages/source_code_locations.htm">Source Code Locations</a> document for details on the source archive naming convention. </p>
<p>The <strong>Package as individual JAR archives</strong> option packages features and their constituent plug-ins as JARs. If the option is not selected, then the features are exported as flat directories, while their constituent plug-ins are packaged as specified in the <em>feature.xml</em> markup. Plug-in entries that are marked with <em><strong>unpack=&quot;false&quot;</strong></em> in the <em>feature.xml</em> are exported as JARs; otherwise, they are exported as directories. </p>
<p>The <strong>Qualifier replacement</strong> option enables you to substitute a value for the qualifier element in a plug-in's version or feature's version. The version must be in the following format: &lt;<em>major</em>&gt;.&lt;<em>minor</em>&gt;.&lt;<em>micro</em>&gt;.qualifier. For example: 3.3.0.qualifier. Normally, the qualifier represents a build date or identifier.</p>
<p>The <strong>Save as Ant script</strong> option lets you save the settings of the export operation so that it can be re-executed at a later time without having to go through the wizard again. Like the export operation, the Ant task runs as an asynchronous job; therefore, it may not be suitable to incorporate it as a part of a larger Ant script. </p>
<p>&nbsp;</p>
<p class="style2">JAR Signing </p>
<p>The <strong>JAR Signing</strong> tab is only visible when the <strong>Package as individual JAR archives</strong> option is selected on the <strong>Options</strong> tab. </p>
<p><img src="../../images/export_wizards/jar_signing_features.png" alt="JAR Signing" hspace="30"></p>
<p>To sign the JARs, <em><strong>you must be running Eclipse with a full JDK, rather than just a JRE. </strong></em></p>
<p>The <strong>Keystore location</strong>, <strong>Alias</strong> and <strong>Password</strong> fields are all required for the signing operation.</p>
<p>&nbsp;</p>
<p class="style2">Java Web Start</p>
<p>The <strong>Java Web Start</strong> tab is only available when the <strong>Directory</strong> option is selected on the <strong>Destination</strong> tab and the <strong>Package as individual JAR archives</strong> option is selected on the <strong>Options</strong> tab. </p>
<p><img src="../../images/export_wizards/webstart_features.png" alt="Java Web Start" hspace="30"> .</p>
<p>The <strong>Site URL</strong> and <strong>JRE version</strong> fields are both required.</p>
<p>&nbsp; </p>
<p>&nbsp; </p>
</body>
</html>