Jump to: navigation, search

Difference between revisions of "FAQ Can I install plug-ins outside the main install directory?"

(See Also:)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
Users who like to “live on the edge” will be frequently installing new builds of Eclipse.
+
Users who like to &#147;live on the edge&#148; will be frequently installing new builds of Eclipse. When a new build is installed,  a manual step is generally required to copy over any extra plug-ins from the old build to the new one.  We all know how much programmers hate manual steps, so it would be nice if there were an easy way to link a set of external plug-ins into  Eclipse builds.  A mechanism to do that is called a <i>product extension</i>.
When a new build is installed,  a manual step is generally required to copy
+
over any extra plug-ins from the old build to the new one.  We all know
+
how much programmers hate manual steps, so it would be nice if there were an
+
easy way to link a set of external plug-ins into  Eclipse builds.   
+
A mechanism to do that is called a <i>product extension</i>.
+
  
 
+
A product extension must be laid out on disk in a certain way so the Eclipse configuration tools can recognize it.  Following is the disk layout for a product extension that contains a single plug-in called <tt>org.eclipse.faq.examples</tt>.
 
+
 
+
A product extension must be laid out on disk in a certain way so the Eclipse
+
configuration tools can recognize it.  Following is the disk layout for a product extension
+
that contains a single plug-in called  
+
<tt>org.eclipse.faq.examples</tt>.
+
  
 
<pre>
 
<pre>
Line 25: Line 14:
 
         ... features would go here ...
 
         ... features would go here ...
 
</pre>
 
</pre>
The file <tt>.eclipseextension</tt> is empty, acting as a special
 
marker that tells install tools that this is an Eclipse extension.  Other than
 
that special file, the layout is the same as that for an Eclipse product.
 
Plug-ins go in a directory called <tt>plugins</tt>, and if the extension
 
contains features, they go in a sibling directory called <tt>features</tt>.
 
 
 
 
 
Once you&#146;ve got this directory structure set up, you have to link the product
 
extension into your plug-in configuration.  In Eclipse 3.0, you simply go to
 
'''Help &gt; Software Updates &gt; Manage Configuration''',  choose
 
the option called '''Link an Extension Location''', and select the extension
 
directory when prompted.  That&#146;s all there is to it!  As long as you keep the same
 
workspace when you upgrade to a new build, the product extensions will automatically
 
be available in the new configuration.
 
 
 
  
 +
The file <tt>.eclipseextension</tt> is empty, acting as a special marker that tells install tools that this is an Eclipse extension.  Other than
 +
that special file, the layout is the same as that for an Eclipse product. Plug-ins go in a directory called <tt>plugins</tt>, and if the extension contains features, they go in a sibling directory called <tt>features</tt>.
  
 +
Once you&#146;ve got this directory structure set up, you have to link the product extension into your plug-in configuration.  In Eclipse 3.0, you simply go to '''Help &gt; Software Updates &gt; Manage Configuration''',  choose the option called '''Add an Extension Location''', and select the extension directory when prompted.  That&#146;s all there is to it!  As long as you keep the same workspace when you upgrade to a new build, the product extensions will automatically be available in the new configuration.
  
  
 
== See Also: ==
 
== See Also: ==
 
  
 
[[FAQ_How_do_I_upgrade_Eclipse%3F]]
 
[[FAQ_How_do_I_upgrade_Eclipse%3F]]
 
  
 
[[FAQ_How_do_I_remove_a_plug-in%3F]]
 
[[FAQ_How_do_I_remove_a_plug-in%3F]]
  
<hr><font size=-2>This FAQ was originally published in [http://www.eclipsefaq.org Official Eclipse 3.0 FAQs]. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1.0].</font>
+
{{Template:FAQ_Tagline}}

Latest revision as of 12:53, 30 May 2013

Users who like to “live on the edge” will be frequently installing new builds of Eclipse. When a new build is installed, a manual step is generally required to copy over any extra plug-ins from the old build to the new one. We all know how much programmers hate manual steps, so it would be nice if there were an easy way to link a set of external plug-ins into Eclipse builds. A mechanism to do that is called a product extension.

A product extension must be laid out on disk in a certain way so the Eclipse configuration tools can recognize it. Following is the disk layout for a product extension that contains a single plug-in called org.eclipse.faq.examples.

   eclipse/
      .eclipseextension
      plugins/
         org.eclipse.faq.examples/
            plugin.xml
            examples.jar
         ... optionally more plug-in directories ...
      features/
         ... features would go here ...

The file .eclipseextension is empty, acting as a special marker that tells install tools that this is an Eclipse extension. Other than that special file, the layout is the same as that for an Eclipse product. Plug-ins go in a directory called plugins, and if the extension contains features, they go in a sibling directory called features.

Once you’ve got this directory structure set up, you have to link the product extension into your plug-in configuration. In Eclipse 3.0, you simply go to Help > Software Updates > Manage Configuration, choose the option called Add an Extension Location, and select the extension directory when prompted. That’s all there is to it! As long as you keep the same workspace when you upgrade to a new build, the product extensions will automatically be available in the new configuration.


See Also:

FAQ_How_do_I_upgrade_Eclipse?

FAQ_How_do_I_remove_a_plug-in?


This FAQ was originally published in Official Eclipse 3.0 FAQs. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the Eclipse Public License v1.0.