platform-update-home/doc/eclipse_update_packaging.html

Parent Directory | Revision Log | Patch

-revision 1.16, Thu Jan 23 18:23:59 2003 UTC
+revision 1.17, Thu Jan 23 21:34:37 2003 UTC
 Line 14
  <h1> Eclipse Platform<br>
              Update Packaging Conventions</h1>
-             <font size="-1">Revision Date: 01/22/2003 9:56AM - Version: 2.0.18</font><br>
+              <font size="-1">Revision Date: 01/22/2003 9:56AM - Version:
+.0.18</font><br>
             <a href="../../../../../hglegal.htm"><img src="ngibmcpy.gif"
   border="0" height="12" width="195">
             </a>
-Line 53
+Line 54
                                </li>
             <li><small>2.0.14<br>
                </small>
      <ul>
                  <li><small>added &lt;site&gt;&lt;feature&gt; label tag</small><br>
                  </li>
-Line 63
+Line 65
               </small> </li>
    <ul>
-                <li><small>added &lt;includes name,optional,match,search_location</small>
+                 <li><small>added &lt;includes name,optional,match,search-location</small>
       &gt;</li>
                 <li><small>added &lt;import feature,patch&gt;</small></li>
-Line 92
+Line 94
               <li> <font size="-1">2.0.9</font></li>
    <ul>
-             <li> <font size="-1">&lt;site&gt; &lt;feature&gt; changes - additional
+              <li> <font size="-1">&lt;site&gt; &lt;feature&gt; changes -
-      markup to optionally expose feature identification information to speed
+ additional      markup to optionally expose feature identification information
-    up  searches</font></li>
+ to speed    up  searches</font></li>
               <li> <font size="-1">removed obsolete text</font></li>
               <li> <font size="-1">web-triggered update not in 2.0</font></li>
               <li> <font size="-1">no assist in 2.0 for license/ "key file"
-Line 160
+Line 162
   href="#Plug-In_Archive">Plug-In     Archive</a>  <br>
             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="#Packaging_NL">Packaging
      NL</a>   <br>
-            &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a
+             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-  href="#Translated_Feature_Information"> Translated Feature Information</a>
+ <a href="#Translated_Feature_Information"> Translated Feature Information</a>
        <br>
-            &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a
+             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-  href="#Translated_Plug-In_Information"> Translated Plug-In Information</a>
+ <a href="#Translated_Plug-In_Information"> Translated Plug-In Information</a>
        <br>
             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a
   href="#Packaging_Target-Specific_Support"> Packaging Target-Specific Support</a>
-Line 217
+Line 219
    is  merged  into <i>feature</i>. Features define the packaging structure
   for a group of related plug-ins, plug-in fragments, and optionally non-plug-in
     files. Features are treated purely as an installation and packaging construct.
-    They do not play a role during Eclipse plug-in execution. Features do
+    They do not play a role during Eclipse plug-in execution. Features do not
- not    nest. They are simply an inclusive "manifest" of the plug-ins, fragments
+    nest. They are simply an inclusive "manifest" of the plug-ins, fragments
    and other files that make up that feature. If features are logically made
    up of plug-ins from "sub-features", the top-level feature "manifest" must
    be fully resolved at packaging time. <li> <b>default feature archive format</b></li>
-Line 226
+Line 228
             R1.0 components were packaged as a single Java .jar containing
  the   component    manifest as well as the actual plug-in files. The problem
  with   this approach    is lack of granularity at download time. In R2.0,
- the feature   archive consists    of multiple separate .jars - one .jar per
+  the feature   archive consists    of multiple separate .jars - one .jar
- plug-in and   fragment, plus one   .jar for the actual feature information.
+ per  plug-in and   fragment, plus one   .jar for the actual feature information.
- The Installation   and Update support   selectively downloads only those jars
+  The Installation   and Update support   selectively downloads only those
- required for the  installation. <li>    <b>site map</b></li>
+ jars required for the  installation. <li>    <b>site map</b></li>
               <br>
-            Default Eclipse update server must contain a <i>site map</i> file
+             Default Eclipse update server must contain a <i>site map</i>
-   (site.xml).     This is an evolution of the R1.0 install.index support.
+ file   (site.xml).     This is an evolution of the R1.0 install.index support.
  The  rationale for    using a structured site defined by the map rather than
  a  "free form" web   site, is the ability to present a consistent installation
    experience for  the user. Also, this provides the necessary structure for
-Line 246
+Line 248
     support  for understanding the Eclipse installation structure. In particular,
     the native uninstallers will, by default, remove plug-in files that were
    installed using the native installer without regard to these plug-ins being
-   needed by other features. As a result, features installed using native
+   needed by other features. As a result, features installed using native installers
- installers     must be written into private product-specific installation
+     must be written into private product-specific installation location and
- location and   not  the shared Eclipse installation location. The shared
+   not  the shared Eclipse installation location. The shared Eclipse is made
- Eclipse is made   aware  of the produce-specific location via an installed
+   aware  of the produce-specific location via an installed "link file". <li>
- "link file". <li>           <b>custom  install handling</b></li>
+           <b>custom  install handling</b></li>
-              <br>
+               <br>
-            In many cases the standard installation handling supplied by Eclipse
+             In many cases the standard installation handling supplied by
-    is  not be sufficient to handle various custom requirements. To accommodate
+ Eclipse     is  not be sufficient to handle various custom requirements.
-     this,  R2.0 Eclipse supports custom install handlers packaged as part
+ To accommodate     this,  R2.0 Eclipse supports custom install handlers packaged
- of   the feature  and executed during the feature installation. <li> <b>path
+ as part of   the feature  and executed during the feature installation. <li>
-  naming   conventions</b></li>
+     <b>path  naming   conventions</b></li>
               <br>
             R1.0 mandated the use of the various identifiers and versions
  inside    the   packaged archives (eg. directory path names for plug-ins).
  This approach     has proven to be ackward and error prone. In 2.0, the packaging
  requirements     no longer mandate that path names of packaged files precisely
  reflect the    contained identifiers and versions. The properly identified
- install subdirectories    are created by the Eclipse support during the installation
+  install subdirectories    are created by the Eclipse support during the
-  and update process     based on the archive content (rather than explicit
+ installation  and update process     based on the archive content (rather
-  jar path structure set    up at packaging time)
+ than explicit  jar path structure set    up at packaging time)
  </ul>
  <h3> <a name="Concepts"></a> Concepts</h3>
-Line 279
+Line 282
  <p>While plug-ins are being developed (ie. are frequently being changed),
        their internal file structure will reflect what is convenient to the
-  developer.     This will generally depend on the particular development
+  developer.     This will generally depend on the particular development tool
- tool  being used.     Typically, however, the developer will likely setup
+  being used.     Typically, however, the developer will likely setup the
- the plug-in  to execute     from a directory tree containing exposed .class
+ plug-in  to execute     from a directory tree containing exposed .class files,
- files, rather  than executing     from a .jar (requires an extra step to
+ rather  than executing     from a .jar (requires an extra step to create
- create the .jar  and we all know  developers  hate extra steps). Also, at
+ the .jar  and we all know  developers  hate extra steps). Also, at this stage
- this stage the developer  does not  pay particular  attention to plug-in
+ the developer  does not  pay particular  attention to plug-in versioning
- versioning information, because  the plug-in is continually  changing. </p>
+ information, because  the plug-in is continually  changing. </p>
  <p>However, when the plug-in is ready to be packaged, it needs to be converted
        to a form suitable for packaging and installation. Typically it means
-Line 306
+Line 309
  <p><b>Feature</b> <br>
             A feature is an installation packaging mechanism used to define
   a  group    of versioned plug-ins and/or plug-in fragments plus non-plug-in
-  files that    is used to deliver some user function. A feature can also
+  files that    is used to deliver some user function. A feature can also include
- include   other  features.  Features are exposed to users as part of the
+   other  features.  Features are exposed to users as part of the packaging
- packaging  and installation   process,  because they represent a unit of
+  and installation   process,  because they represent a unit of function selection.
- function selection.   Features also  represent  a unit of installation. Features
+   Features also  represent  a unit of installation. Features carry a version
- carry a version   identifier.</p>
+   identifier.</p>
  <p>Features are packaged as a feature archive, referencing the required plug-ins,
       plug-in fragments and optional non-plug-in files. The feature archives
-   are   placed on an update server for download and installation by the Eclipse
+    are   placed on an update server for download and installation by the
-    update  manager, or they can be used as the input into a formal packaging
+ Eclipse     update  manager, or they can be used as the input into a formal
-    process  using one of the "traditional" installer technologies. The format
+ packaging     process  using one of the "traditional" installer technologies.
-    of the feature archive is described later. </p>
+ The format     of the feature archive is described later. </p>
  <h3> <a name="Framework"></a> Framework</h3>
              The 2.0 installation and update support is provided as a framework
-Line 329
+Line 332
  feature   types   are  registere via the "org.eclipse.update.featureTypes"
  extension   point.</li>
               <li> concrete implementations of site (ISite interface) that
- can   be  used  to support alternate site layout, or site behavior. New concrete
+  can   be  used  to support alternate site layout, or site behavior. New
-   site  types   are registered via the "org.eclipse.update.siteTypes" extension
+ concrete    site  types   are registered via the "org.eclipse.update.siteTypes"
-    point.</li>
+ extension    point.</li>
               <li> each feature can specify a custom install handler as part
   of  its   feature  manifest. Install handlers (IInstallHandler interface)
   are  dynamically   invoked as part of the installation process to handle
- non-plugin  data, plus   perform other custom processing allowed by the framework.</li>
+  non-plugin  data, plus   perform other custom processing allowed by the
+ framework.</li>
  </ul>
              Eclipse provides default implementations of feature and site.
-Line 344
+Line 348
  <table border="1" cols="1" width="100%">
              <tbody>
                 <tr>
-             <td><b>Note: <i>The reminder of this document describes the default
+              <td><b>Note: <i>The reminder of this document describes the
-    concrete   implementation of the framework delivered with Eclipse. It specifies
+ default     concrete   implementation of the framework delivered with Eclipse.
-    the  structure of the default feature implementation, as well as the default
+ It specifies    the  structure of the default feature implementation, as
-    site  implementation, plus the corresponding xml files (feature.xml and
+ well as the default    site  implementation, plus the corresponding xml files
-  site.xml).   Providers of alternate concrete implementations can extend&nbsp;
+ (feature.xml and  site.xml).   Providers of alternate concrete implementations
-  parts or   all of the default Eclipse implementation. This includes providing
+ can extend&nbsp;  parts or   all of the default Eclipse implementation. This
-  a mechanism   for dynamic computation of the site map (site.xml)</i></b></td>
+ includes providing  a mechanism   for dynamic computation of the site map
+ (site.xml)</i></b></td>
              </tr>
    </tbody>
-Line 371
+Line 376
  </ul>
  <h3> <a name="Feature_Archive"></a> Feature Archive</h3>
-             The feature packaging information is placed into a separate Java
+              The feature packaging information is placed into a separate
-   .jar.    Standard Java jar facilities are used for constructing feature
+ Java   .jar.    Standard Java jar facilities are used for constructing feature
  archives.    Feature archives reference separately packaged plug-in archives
  (see next    section) and non-plug-in files.
  <p>Features are identified using a structured identifier based on the provider
-Line 386
+Line 391
  <p>Where <tt>&lt;id&gt;</tt> is the feature identifier and <tt>&lt;version&gt;</tt>
        is the full version identifier contained in the respective feature.xml.
-      Note that this is a recommended convention that minimizes chance of
+      Note that this is a recommended convention that minimizes chance of collisions,
- collisions,       but is not required by the Eclipse architecture. For example,
+       but is not required by the Eclipse architecture. For example, the following
- the following       are valid feature archive names </p>
+       are valid feature archive names </p>
  <p><tt>org.eclipse.javatooling_1.0.3.jar</tt> <br>
             <tt>org.eclipse.pde_2.0.jar</tt> <br>
             <tt>my_feature.jar</tt> </p>
  <p>Internally, each feature archive is packaged relative to its feature directory
-      (but not including the directory path element). The archive has the following
+       (but not including the directory path element). The archive has the
-      structure </p>
+ following      structure </p>
  <p><tt>feature.xml</tt> <br>
             <tt>feature&lt;_locale&gt;.properties (see "Translated Feature
-Line 410
+Line 415
  <p><tt>&lt;?xml encoding="ISO-8859-1"?&gt;</tt> </p>
- <p><tt>&lt;!ELEMENT feature (install-handler?, description?, copyright?,
+ <p><tt>&lt;!ELEMENT feature (install-handler?, description?, copyright?, license?,
- license?, url?, includes*, requires?, plugin*, data*)&gt;</tt> <br>
+ url?, includes*, requires?, plugin*, data*)&gt;</tt> <br>
             <tt>&lt;!ATTLIST feature</tt> <br>
             <tt>&nbsp;&nbsp;&nbsp; id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        CDATA #REQUIRED</tt> <br>
-Line 497
+Line 502
             </tt><tt>&nbsp;&nbsp;&nbsp; match&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        &nbsp;&nbsp;&nbsp; (perfect | equivalent | compatible | greaterOrEqual)
      "compatible"</tt><tt> &nbsp; &nbsp;&nbsp;&nbsp; </tt><br>
-            <tt>&nbsp;&nbsp;&nbsp; search_location&nbsp;&nbsp; </tt><tt>(</tt><font
+             <tt>&nbsp;&nbsp;&nbsp; search-location&nbsp;&nbsp; </tt><tt>(</tt><font
   color="#000000"><tt> root | self | both) "root"</tt></font><br>
             <tt>&gt;</tt> </p>
-Line 573
+Line 578
               <li> os - optional operating system specification. A comma-separated
      list  of os designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt>
       . Indicates this feature should only be installed on one of the specified
-       os systems. If this attribute is not specified, the feature can be
+       os systems. If this attribute is not specified, the feature can be installed
- installed       on all systems (portable implementation). This information
+       on all systems (portable implementation). This information is used
- is used as   a  hint by the installation and update support (user can force
+ as   a  hint by the installation and update support (user can force installation
- installation    of feature regardless of this setting).</li>
+    of feature regardless of this setting).</li>
-              <li> arch - optional machine architecture specification. A comma-separated
+               <li> arch - optional machine architecture specification. A
-      list of architecture designators defined by Eclipse (see Javadoc for
+ comma-separated       list of architecture designators defined by Eclipse
-       <tt>     org.eclipse.core.boot.BootLoader)</tt>. Indicates this feature
+ (see Javadoc for        <tt>     org.eclipse.core.boot.BootLoader)</tt>.
-  should only    be installed on one of the specified systems. If this attribute
+ Indicates this feature   should only    be installed on one of the specified
-  is not specified,   the feature can be installed on all systems (portable
+ systems. If this attribute   is not specified,   the feature can be installed
-  implementation).  This   information is used as a hint by the installation
+ on all systems (portable   implementation).  This   information is used as
-  and update support  (user   can force installation of feature regardless
+ a hint by the installation   and update support  (user   can force installation
- of this setting).</li>
+ of feature regardless  of this setting).</li>
               <li> ws - optional windowing system specification. A comma-separated
      list  of ws designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt>
       . Indicates this feature should only be installed on one of the specified
-       ws systems. If this attribute is not specified, the feature can be
+       ws systems. If this attribute is not specified, the feature can be installed
- installed       on all systems (portable implementation). This information
+       on all systems (portable implementation). This information is used
- is used as   a  hint by the installation and update support (user can force
+ as   a  hint by the installation and update support (user can force installation
- installation    of feature regardless of this setting).</li>
+    of feature regardless of this setting).</li>
-              <li> nl - optional locale specification. A comma-separated list
+               <li> nl - optional locale specification. A comma-separated
-   of  locale   designators defined by Java. Indicates this feature should
+ list   of  locale   designators defined by Java. Indicates this feature should
- only  be installed   on a system running with a compatible locale (using
+ only  be installed   on a system running with a compatible locale (using Java
- Java locale-matching    rules). If this attribute is not specified, the feature
+ locale-matching    rules). If this attribute is not specified, the feature
   can be installed   on all systems (language-neutral implementation). This
-  information is used   as a hint by the installation and update support (user
+   information is used   as a hint by the installation and update support
-  can force installation    of feature regardless of this setting).</li>
+ (user   can force installation    of feature regardless of this setting).</li>
               <li> colocation-affinity - optional reference to another feature
    identifier    used to select the default installation location for this
  feature.  When  this feature is being installed as a new feature (no other
  versions  of it  are installed), an attempt is made to install this feature
  in the same installation    location as the referenced feature.</li>
-              <li> primary - optional indication specifying whether this feature
+               <li> primary - optional indication specifying whether this
-    can   be used as a <a href="#Dominant_Feature">primary feature</a> . Default
+ feature     can   be used as a <a href="#Dominant_Feature">primary feature</a>
-    if        <i>false</i> (not a primary feature).</li>
+ . Default     if        <i>false</i> (not a primary feature).</li>
               <li> application - optional identifier of the Eclipse application
     that   is to be used during startup when the declaring feature is the
-       <a href="#Dominant_Feature"> primary feature</a> . The application
+      <a href="#Dominant_Feature"> primary feature</a> . The application identifier
- identifier      must represent a valid application registered in the <tt>org.eclipse.core.runtime.applications</tt>
+      must represent a valid application registered in the <tt>org.eclipse.core.runtime.applications</tt>
       extension point. Default is <tt>org.eclipse.ui.workbench</tt>.</li>
       <li> plugin- optional identifier of the primary plugin associated with
  this <a
-Line 623
+Line 628
               <li> &lt;install-handler&gt;</li>
    <ul>
-             <li> library - optional .jar library containing the install handler
+              <li> library - optional .jar library containing the install
-    classes.   If specified, the referenced .jar must be contained in the feature
+ handler     classes.   If specified, the referenced .jar must be contained
-    archive.   It is specified as a path within the feature archive, relative
+ in the feature    archive.   It is specified as a path within the feature
-    to the feature.xml   entry. If not specified, the feature archive itself
+ archive, relative    to the feature.xml   entry. If not specified, the feature
-   is used to load the install handler classes. This attribute is only interpreted
+ archive itself   is used to load the install handler classes. This attribute
-    if <i>class</i> attribute is also specified</li>
+ is only interpreted    if <i>class</i> attribute is also specified</li>
-              <li> handler - optional identifier of the install handler. The
+               <li> handler - optional identifier of the install handler.
-  value    is  interpreted depending on the value of the <i>library</i> attribute.
+ The   value    is  interpreted depending on the value of the <i>library</i>
-   If        <i>  library</i> is specified,&nbsp; the value is interpreted
+ attribute.    If        <i>  library</i> is specified,&nbsp; the value is
- as  a fully qualified  name of a class contained in the specified <i>library</i>.
+ interpreted  as  a fully qualified  name of a class contained in the specified
-    If       <i>library</i>   is not specified, the value is is interpreted
+       <i>library</i>.     If       <i>library</i>   is not specified, the
-  as  an extension identifier  of an extension registered in the <i>org.eclipse.update.installHandlers</i>
+ value is is interpreted   as  an extension identifier  of an extension registered
-       extension point. In either case, the resulting class must implement
+ in the <i>org.eclipse.update.installHandlers</i>        extension point.
- the          <i> IInstallHandler</i> interface. The class is dynamically loaded
+ In either case, the resulting class must implement  the          <i> IInstallHandler</i>
-   and called at specific points during feature processing. The handler has
+ interface. The class is dynamically loaded   and called at specific points
-  visibility to the API classes from the update plug-in, and Eclipse plug-ins
+ during feature processing. The handler has  visibility to the API classes
-    required by the update plugin.</li>
+ from the update plug-in, and Eclipse plug-ins    required by the update plugin.</li>
    </ul>
               <li> &lt;description&gt; - brief component description as simple
-Line 649
+Line 654
              <li> url - optional URL for the full description as HTML. The
  URL   can   be  specified as absolute of relative. If relative, it is assumed
  to  be relative   to (and packaged in) the feature archive. Note, that for
- NL  handling the  URL value should be separated to allow alternate URLs to
+  NL  handling the  URL value should be separated to allow alternate URLs
- be  specified for  each national language. &nbsp;URL support keywords $os$,$ws$,$arch$
+ to  be  specified for  each national language. &nbsp;URL support keywords
-  and $nl$ that will be replaced by the appropriate operating system, windowing
+ $os$,$ws$,$arch$  and $nl$ that will be replaced by the appropriate operating
-  system, operating architecture or national language value.</li>
+ system, windowing  system, operating architecture or national language value.</li>
    </ul>
-              <li> &lt;copyright&gt; - feature copyright as simple text. Intended
+               <li> &lt;copyright&gt; - feature copyright as simple text.
-     to  be translated.</li>
+ Intended     to  be translated.</li>
    <ul>
              <li> url - optional URL for the full description as HTML. The
  URL   can   be  specified as absolute of relative. If relative, it is assumed
  to  be relative   to (and packaged in) the feature archive. Note, that for
- NL  handling the  URL value should be separated to allow alternate URLs to
+  NL  handling the  URL value should be separated to allow alternate URLs
- be  specified for  each national language. URL support keywords $os$,$ws$,$arch$
+ to  be  specified for  each national language. URL support keywords $os$,$ws$,$arch$
   and $nl$ that will be replaced by the appropriate operating system, windowing
   system, operating architecture or national language value.</li>
-Line 672
+Line 677
    text.    Intended to be translated. It is displayed in a standard dialog
   with [Accept]    [Reject] actions during the download/ installation process.
   Note, that click-through   license must be specified for any feature that
-  will be selected for installation   or update using the Eclipse update manager.
+   will be selected for installation   or update using the Eclipse update
-   When using nested features, only the nesting parent (ie. the feature selected
+ manager.    When using nested features, only the nesting parent (ie. the
-   for installation or update) must have click-through license text defined.
+ feature selected    for installation or update) must have click-through license
-   The license text is required even if the optional <i>url</i> attribute is
+ text defined.    The license text is required even if the optional <i>url</i>
-   specified.</li>
+ attribute is   specified.</li>
    <ul>
              <li> url - optional URL for the full description as HTML. The
  URL   can   be  specified as absolute of relative. If relative, it is assumed
  to  be relative   to (and packaged in) the feature archive. Note, that for
- NL  handling the  URL value should be separated to allow alternate URLs to
+  NL  handling the  URL value should be separated to allow alternate URLs
- be  specified for  each national language. Note, that the "content" of this
+ to  be  specified for  each national language. Note, that the "content" of
- URL  is <b>not</b>    what is presented as the click-through license during
+ this  URL  is <b>not</b>    what is presented as the click-through license
- installation  processing.    The click-through license is the actual value
+ during  installation  processing.    The click-through license is the actual
- of the <i>&lt;license&gt;</i>      element (eg. <tt>&lt;license&gt;click through
+ value  of the <i>&lt;license&gt;</i>      element (eg. <tt>&lt;license&gt;click
- text&lt;/license&gt;</tt>).&nbsp;URL support keywords $os$,$ws$,$arch$ and
+ through text&lt;/license&gt;</tt>).&nbsp;URL support keywords $os$,$ws$,$arch$
- $nl$ that will be replaced by the appropriate operating system, windowing
+ and $nl$ that will be replaced by the appropriate operating system, windowing
  system, operating architecture or national language value.</li>
    </ul>
-              <li> &lt;url&gt; - optional URL specifying site(s) contain feature
+               <li> &lt;url&gt; - optional URL specifying site(s) contain
-    updates,   or new features</li>
+ feature     updates,   or new features</li>
    <ul>
              <li> &lt;update&gt; - URL to go to for updates to this feature</li>
      <ul>
              <li> url - actual URL</li>
               <li> label - displayable label (name) for the referenced site</li>
      </ul>
-              <li> &lt;discovery&gt; - URL to go to for new features. In general,
+               <li> &lt;discovery&gt; - URL to go to for new features. In
-     a  provider  can use this element to reference its own site(s), or site(s)
+ general,     a  provider  can use this element to reference its own site(s),
-     of  partners  that offer complementary features. Eclipse uses this element
+ or site(s)     of  partners  that offer complementary features. Eclipse uses
-     simply  as a way to distribute new site URLs to the clients</li>
+ this element     simply  as a way to distribute new site URLs to the clients</li>
      <ul>
              <li> url - actual URL</li>
-Line 716
+Line 723
    </ul>
               <li> &lt;includes&gt; - optional reference to a nested feature
-  that   is  considered to be part of this feature. Nested features must be
+   that   is  considered to be part of this feature. Nested features must
-  located   on  the same update site as this feature</li>
+ be   located   on  the same update site as this feature</li>
    <ul>
              <li> id - required nested feature identifier</li>
               <li> version - required nested feature version</li>
                 <li> name- optional displayable label (name). Intended to
  be  translated.</li>
-                <li>optional - optional specification indicating if this included
+                 <li>optional - optional specification indicating if this
-     feature  can be optionally installed. Default is "false"<br>
+ included     feature  can be optionally installed. Default is "false"<br>
                 </li>
                 <li>match&nbsp; - optional rule that will be applied when
  resolving      the feature reference. A <samp>perfect</samp> match (the default
-Line 736
+Line 743
  part to be included in the   consideration, while <samp>greaterOrEqual</samp>
    simply allows any version   that is more recent or identical to the one
  specified).</li>
-                <li>search_location&nbsp; - optional. Indicates whether the
+                 <li>search-location&nbsp; - optional. Indicates whether the
   "New   Updates"   action should search the update location determined by
  the nesting   root feature  (<tt>root</tt>, is the default), or the location
  defined by   the nested feature  (<tt>self</tt>), or search both (<tt>both</tt>)
-Line 751
+Line 758
              <li> &lt;import&gt; - dependency entry. Specification and processing
      is  a subset of the &lt;import&gt; specification in plugin.xml</li>
      <ul>
              <li> plugin - identifier of dependent plug-in.</li>
                   <li> feature - identifier of dependent feature. If plugin
-Line 806
+Line 814
       on all systems (portable implementation). This information is used as
   a  hint  by the installation and update support (user can force installation
     of entry  regardless of this setting).</li>
-              <li> arch - optional machine architecture specification. A comma-separated
+               <li> arch - optional machine architecture specification. A
-      list of architecture designators defined by Eclipse (see Javadoc for
+ comma-separated       list of architecture designators defined by Eclipse
-       <tt>     org.eclipse.core.boot.BootLoader)</tt>. Indicates this feature
+ (see Javadoc for        <tt>     org.eclipse.core.boot.BootLoader)</tt>.
-  should only    be installed on one of the specified systems. If this attribute
+ Indicates this feature   should only    be installed on one of the specified
-  is not specified,   the feature can be installed on all systems (portable
+ systems. If this attribute   is not specified,   the feature can be installed
-  implementation).  This   information is used as a hint by the installation
+ on all systems (portable   implementation).  This   information is used as
-  and update support  (user   can force installation of feature regardless
+ a hint by the installation   and update support  (user   can force installation
- of this setting).</li>
+ of feature regardless  of this setting).</li>
               <li> ws - optional windowing system specification. A comma-separated
      list  of ws designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt>
       . Indicates this entry should only be installed on one of the specified
-Line 821
+Line 829
       on all systems (portable implementation). This information is used as
   a  hint  by the installation and update support (user can force installation
     of entry  regardless of this setting).</li>
-              <li> nl - optional locale specification. A comma-separated list
+               <li> nl - optional locale specification. A comma-separated
-   of  locale   designators defined by Java. Indicates this entry should only
+ list   of  locale   designators defined by Java. Indicates this entry should
-   be  installed   on a system running with a compatible locale (using Java
+ only   be  installed   on a system running with a compatible locale (using
-  locale-matching   rules). If this attribute is not specified, the entry
+ Java  locale-matching   rules). If this attribute is not specified, the entry
  can  be installed on   all systems (language-neutral implementation). This
  information  is used as  a hint by the installation and update support (user
  can force  installation   of entry regardless of this setting).</li>
-              <li> download-size - optional hint supplied by the feature packager,
+               <li> download-size - optional hint supplied by the feature
-     indicating  the download size in KBytes of the referenced plug-in archive.The
+ packager,      indicating  the download size in KBytes of the referenced
- size should not contain decimal.     If not specified,  the download size
+ plug-in archive.The size should not contain decimal.     If not specified,
- is not known (<b>Implementation Note:</b>     the implementation  needs to
+  the download size is not known (<b>Implementation Note:</b>     the implementation
- distinguish between "not known" and 0 size)</li>
+  needs to distinguish between "not known" and 0 size)</li>
               <li> install-size - optional hint supplied by the feature packager,
      indicating   the install size in KBytes of the referenced plug-in archive.
-     The size should not contain decimal. If not specified,   the install
+     The size should not contain decimal. If not specified,   the install size
- size is not known (<b>Implementation Note:</b>     the implementation   needs
+ is not known (<b>Implementation Note:</b>     the implementation   needs to
- to distinguish between "not known" and 0 size)</li>
+ distinguish between "not known" and 0 size)</li>
    </ul>
               <li> &lt;data&gt; - identifies non-plugin and non-feature data
   that  is part of the feature. Generally, data are post-install processed
- using feature Install handler. Feature files like feature.properties are not
+  using feature Install handler. Feature files like feature.properties are
- considered  data.</li>
+ not considered  data.</li>
    <ul>
              <li> id - required data identifier in the form of a relative
-Line 855
+Line 863
       on all systems (portable implementation). This information is used as
   a  hint  by the installation and update support (user can force installation
     of entry  regardless of this setting).</li>
-              <li> arch - optional machine architecture specification. A comma-separated
+               <li> arch - optional machine architecture specification. A
-      list of architecture designators defined by Eclipse (see Javadoc for
+ comma-separated       list of architecture designators defined by Eclipse
-       <tt>     org.eclipse.core.boot.BootLoader)</tt>. Indicates this feature
+ (see Javadoc for        <tt>     org.eclipse.core.boot.BootLoader)</tt>.
-  should only    be installed on one of the specified systems. If this attribute
+ Indicates this feature   should only    be installed on one of the specified
-  is not specified,   the feature can be installed on all systems (portable
+ systems. If this attribute   is not specified,   the feature can be installed
-  implementation).  This   information is used as a hint by the installation
+ on all systems (portable   implementation).  This   information is used as
-  and update support  (user   can force installation of feature regardless
+ a hint by the installation   and update support  (user   can force installation
- of this setting).</li>
+ of feature regardless  of this setting).</li>
               <li> ws - optional windowing system specification. A comma-separated
      list  of ws designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt>
       . Indicates this entry should only be installed on one of the specified
-Line 870
+Line 878
       on all systems (portable implementation). This information is used as
   a  hint  by the installation and update support (user can force installation
     of entry  regardless of this setting).</li>
-              <li> nl - optional locale specification. A comma-separated list
+               <li> nl - optional locale specification. A comma-separated
-   of  locale   designators defined by Java. Indicates this entry should only
+ list   of  locale   designators defined by Java. Indicates this entry should
-   be  installed   on a system running with a compatible locale (using Java
+ only   be  installed   on a system running with a compatible locale (using
-  locale-matching   rules). If this attribute is not specified, the entry
+ Java  locale-matching   rules). If this attribute is not specified, the entry
  can  be installed on   all systems (language-neutral implementation). This
  information  is used as  a hint by the installation and update support (user
  can force  installation   of entry regardless of this setting).</li>
-              <li> download-size - optional hint supplied by the feature packager,
+               <li> download-size - optional hint supplied by the feature
-     indicating  the download size in KBytes of the referenced data archive.
+ packager,      indicating  the download size in KBytes of the referenced
-   If  not specified,  the download size is not known (<b>Implementation Note:</b>
+ data archive.    If  not specified,  the download size is not known (<b>Implementation
-     the implementation  needs to distinguish between "not known" and 0 size)</li>
+ Note:</b>      the implementation  needs to distinguish between "not known"
+ and 0 size)</li>
               <li> install-size - optional hint supplied by the feature packager,
      indicating   the install size in KBytes of the referenced data archive.
    If  not specified,   the install size is not known (<b>Implementation Note:</b>
-Line 899
+Line 908
              <li> <tt>&lt;plugin&gt;</tt> element results in a path entry
  in  the   form   "<tt>plugins/&lt;pluginId&gt;_&lt;pluginVersion&gt;.jar</tt>"
   (for   example,   "<tt>plugins/org.eclipse.core.boot_1.0.3.jar</tt>")</li>
-              <li> <tt>&lt;data&gt;</tt> element results in a path entry in
+               <li> <tt>&lt;data&gt;</tt> element results in a path entry
-  the   form   "<tt>features/&lt;featureId&gt;_&lt;featureVersion&gt;/&lt;dataId&gt;</tt>
+ in  the   form   "<tt>features/&lt;featureId&gt;_&lt;featureVersion&gt;/&lt;dataId&gt;</tt>
       " (for example, "f<tt>eatures/com.xyz.tools_2.3.1/examples.zip</tt>")</li>
  </ul>
-Line 910
+Line 919
  <p>Translatable text contained in the feature.xml can be separated into feature&lt;_locale&gt;.properties
       files using Java property bundle conventions. Note that the translated
-   strings   are used at installation time (ie. do not employ the plug-in fragment
+    strings   are used at installation time (ie. do not employ the plug-in
-   runtime   mechanism). </p>
+ fragment   runtime   mechanism). </p>
  <h3> <a name="Plug-In_Archive"></a> Plug-In Archive</h3>
-             Plug-ins and plug-in fragments are individually packaged as separate
+              Plug-ins and plug-in fragments are individually packaged as
-     Java   .jars. Standard Java jar facilities are used for constructing
+ separate     Java   .jars. Standard Java jar facilities are used for constructing
  plug-in     archives.   There is no distinction made between a plug-in archive
  containing     a plug-in   and one containing a plug-in fragment.
-Line 933
+Line 942
             <tt>org.eclipse.ui.nl_2.0.jar</tt> <br>
             <tt>my_plugin.jar</tt> </p>
- <p>Internally, each plug-in archive packages all the relevant plug-in or
+ <p>Internally, each plug-in archive packages all the relevant plug-in or fragment
- fragment files relative to its plug-in or fragment directory (but not including
+ files relative to its plug-in or fragment directory (but not including the
- the directory path element). The archive has the following structure </p>
+ directory path element). The archive has the following structure </p>
  <p><tt>plugin.xml *OR* fragment.xml</tt> <br>
             <tt>other plug-in or feature files and subdirectories</tt> <br>
-Line 946
+Line 955
  <h3> <a name="Packaging_NL"></a> Packaging NL</h3>
              In Eclipse, translated plug-in information is packaged either
  together     with the base plug-in, or as a plug-in fragment. At runtime,
- Eclipse locates     the translations for the required locale. The use of fragments
+  Eclipse locates     the translations for the required locale. The use of
- allows translations     to be added to the runtime without the need to repackage
+ fragments allows translations     to be added to the runtime without the
- the base plug-ins.
+ need to repackage the base plug-ins.
  <p>This mechanism cannot be used for translating the actual packaging information
        that is part of the installation xml files. Consequently the standard
    Java    translation conventions are used for the packaging information,
-Line 957
+Line 966
  <h4> <a name="Translated_Feature_Information"></a> Translated Feature Information</h4>
              <b>Note:</b> This section describes the conventions used for
- translating       the information contained within the feature manifest.
+ translating       the information contained within the feature manifest. It
- It allows for  the    update client to select the correctly localized strings
+ allows for  the    update client to select the correctly localized strings
  from the update    server.  This section specifically does not describe localization
  of individual    plug-ins.
  <p>Several of the attributes within the feature manifest are strings intended
-Line 992
+Line 1001
       </p>
  <p>The resulting resource bundle can be used in <tt>IPluginDescriptor.getResourceString(String,ResourceBundle)</tt>
-       to actually return the correct translated string for the manifest attribute.
+        to actually return the correct translated string for the manifest
-       </p>
+ attribute.       </p>
  <h4> <a name="Translated_Plug-In_Information"></a> Translated Plug-In Information</h4>
              No change from 1.0. Translated plug-in information should be
-Line 1010
+Line 1019
  <h3> <a name="Packaging_Non_Plug_In_Files"></a> Packaging Non-Plug-In Files</h3>
              Arbitrary non-plug-in files can be included as part of the feature
     definition    using the <tt>&lt;data&gt;</tt> elements. Non-plug-in files
-    typically also    requires specification of a custom install handler.
+    typically also    requires specification of a custom install handler. In
- In   general, the Eclipse    support only downloads the referenced non-plug-in
+   general, the Eclipse    support only downloads the referenced non-plug-in
    files and calls the custom    install handler to perform any actual installation
    steps.
  <p>Eclipse does not specify the format of the non-plug-in files. </p>
  <h3> <a name="Custom_Install_Handling"></a> Custom Install Handling</h3>
-             Custom install handlers are written as a Java class and are packaged
+              Custom install handlers are written as a Java class and are
-     as  part of the <a href="#Feature_Archive">feature archive</a> . The
+ packaged     as  part of the <a href="#Feature_Archive">feature archive</a>
- installer      must implement the <tt>IInstallHandler</tt> interface (in
+ . The installer      must implement the <tt>IInstallHandler</tt> interface
- most cases will     extend the <tt>BaseInstallHandler</tt> abstract helper
+ (in most cases will     extend the <tt>BaseInstallHandler</tt> abstract helper
- class which implements     <tt>IInstallHandler</tt>). When required, the
+ class which implements     <tt>IInstallHandler</tt>). When required, the install
- install handler is dynamically     loaded by the installation and update
+ handler is dynamically     loaded by the installation and update code, and
- code, and is called at specific points    during its processing. The install
+ is called at specific points    during its processing. The install handler
- handler code has visibility to classes    from the installation and update
+ code has visibility to classes    from the installation and update support
- support plug-in, and its prerequisite  plug-ins.
+ plug-in, and its prerequisite  plug-ins.
- <p><b>Implementation Note:</b> the detailed list of visible prerequisite
+ <p><b>Implementation Note:</b> the detailed list of visible prerequisite plug-ins
- plug-ins is still evolving. It is expected to include <tt>org.eclipse.core.boot
+ is still evolving. It is expected to include <tt>org.eclipse.core.boot </tt>
- </tt> and <tt>org.eclipse.core.runtime</tt> in all cases, plus <tt>org.eclipse.ui</tt>
+ and <tt>org.eclipse.core.runtime</tt> in all cases, plus <tt>org.eclipse.ui</tt>
-       and <tt>org.eclipse.swt</tt> when running with full workbench (ie. not
+        and <tt>org.eclipse.swt</tt> when running with full workbench (ie.
-    "headless  mode"). Also, it would be useful to always expose <tt>org.eclipse.core.ant</tt>
+ not    "headless  mode"). Also, it would be useful to always expose <tt>org.eclipse.core.ant</tt>
        so that build scripts can be used as part of the install handler implementation.
        </p>
  <p>The IInstallHandler interface supports the following methods [<b>Implementation
-       Note:</b> the detailed definition of the IInstallHandler interface
+       Note:</b> the detailed definition of the IInstallHandler interface is
- is   still    evolving. The description below is not an API specification
+   still    evolving. The description below is not an API specification (simply
- (simply   a functional    description)]: </p>
+   a functional    description)]: </p>
  <ul>
              <li> install-initiated - the install handler is called after
-Line 1052
+Line 1061
   all   the   required  feature files were downloaded (feature, plugins, data)
   but   before   the actual  installation is performed. The install handler
   is expected   to   perform verification  of the non-plug-in data files (eg.
-  security),  or any   other pre-install processing.&nbsp; On return this
+  security),  or any   other pre-install processing.&nbsp; On return this method
- method  indicates   success   (installation continues) or failure (installation
+  indicates   success   (installation continues) or failure (installation is
- is  aborted).</li>
+  aborted).</li>
               <li> install-completion - the install handler is called after
   the   feature   information and the plug-ins were installed. It is expected
-  to  complete the  installation of any non-plug-in data that was part of
+  to  complete the  installation of any non-plug-in data that was part of the
- the  feature.  On return  this method indicates success (returns custom install
+  feature.  On return  this method indicates success (returns custom install
   log) or failure (installation  is aborted). On failure, the install handler
   is expected to perform any required cleanup.</li>
               <li> uninstall-initiated - the install handler is called when
-Line 1066
+Line 1075
    processing    has taken place. It is passed the custom install log created
    by the install    handler install-completion step.</li>
               <li> uninstall-completion - the install handler is called on
- completion      of the standard uninstall steps. It is passed the custom install
+  completion      of the standard uninstall steps. It is passed the custom
- log created     by the install handler install-completion step.</li>
+ install log created     by the install handler install-completion step.</li>
  </ul>
              Note, that as a general practice, install handlers should be
-Line 1080
+Line 1089
  <p>Features are verified as follows: </p>
  <ul>
-             <li> download and verify the feature archive (use base Java jar
+              <li> download and verify the feature archive (use base Java
-  verification)</li>
+ jar   verification)</li>
               <li> for each plug-in archive</li>
    <ul>
-Line 1110
+Line 1119
   in a site   map file, <i>site.xml</i>. This file can be manually maintained,
   or can be  dynamically   computed by the server.
  <h3> <a name="Site_Map"></a> Site Map</h3>
-             The update server URL can be specified as a full URL to the site
+              The update server URL can be specified as a full URL to the
-   map   file,   or a URL of a directory path containing the site map file
+ site   map   file,   or a URL of a directory path containing the site map
- (similar    to index.html   processing). The site map site.xml format is
+ file (similar    to index.html   processing). The site map site.xml format
- defined by  the  following dtd:
+ is defined by  the  following dtd:
  <p><tt>&lt;?xml encoding="ISO-8859-1"?&gt;</tt> </p>
  <p><tt>&lt;!ELEMENT site (description?, feature*, archive*, category-def*)&gt;</tt>
-Line 1189
+Line 1198
     Eclipse site  type (as specified in this document).</li>
               <li> url - optional URL defining the update site baseline URL
   (used    to  determine individual &lt;feature&gt; and &lt;archive&gt; location).&nbsp;
-      Can be relative or absolute. If relative, is relative to site.xml. If
+       Can be relative or absolute. If relative, is relative to site.xml.
-  not    specified, the default is the URL location of the site.xml file.</li>
+ If   not    specified, the default is the URL location of the site.xml file.</li>
    </ul>
               <li> &lt;description&gt; - brief description as simple text.
-Line 1201
+Line 1210
  URL   can   be  specified as absolute of relative. If relative, If relative,
  is   relative   to site.xml.</li>
               <br>
-            Note, that for NL handling the URL value should be separated to
+             Note, that for NL handling the URL value should be separated
-  allow    alternate  URLs to be specified for each national language.
+ to  allow    alternate  URLs to be specified for each national language.
    </ul>
               <li> &lt;feature&gt; - identifies referenced feature archive</li>
-Line 1211
+Line 1220
              <li> type - optional feature type specification. The value refers
    to  a  type  string registered via the <a href="#Framework">install framework</a>
        extension point. If not specified, the type is assumed to be the default
-      feature type for the site. If the site type is the default Eclipse site
+       feature type for the site. If the site type is the default Eclipse
-    type,  the default feature type is the packaged feature type (as specified
+ site     type,  the default feature type is the packaged feature type (as
-    in this  document).</li>
+ specified     in this  document).</li>
               <li> id - optional feature identifier. The information is used
   as  a  performance   optimization to speed up searches for features. Must
-  match  the identifier   specified in the feature.xml of the referenced archive
+   match  the identifier   specified in the feature.xml of the referenced
-   (the  url attribute).   If specified, the version attribute must also be
+ archive   (the  url attribute).   If specified, the version attribute must
-  specified.</li>
+ also be  specified.</li>
               <li> version - optional feature version. The information is
  used   as  a  performance  optimization to speed up searches for features.
- Must  match  the  version specified in the feature.xml of the referenced
+ Must  match  the  version specified in the feature.xml of the referenced archive
- archive  (the url attribute).  If specified, the id attribute must also be
+  (the url attribute).  If specified, the id attribute must also be specified.</li>
- specified.</li>
               <li> url - required URL reference to the feature archive. Can
   be  relative    or absolute. If relative, it is relative to the location
  of the  site.xml   file.       <b>Note</b>: the default site implementation
   allows  features  to be accessed without being explicitly declared using
  a &lt;feature&gt;  entry. By default, an undeclared features reference is
  interpreted as "features/&lt;id&gt;_&lt;version&gt;.jar"</li>
-               <li>label - optional feature label. The value is used for optimization
+                <li>label - optional feature label. The value is used for
-      when browsing the site from the update manager. Intended to be translated.<br>
+ optimization      when browsing the site from the update manager. Intended
+ to be translated.<br>
               </li>
               <li> os - optional operating system specification. A comma-separated
      list  of os designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt>
       . Indicates this feature should only be installed on one of the specified
        os systems. If this attribute is "*", the feature can be installed
+  on   all systems (portable implementation). This information is used as a
+ hint   by the installation and update support (user can force installation
+  of feature   regardless of this setting).</li>
+               <li> arch - optional machine architecture specification. A
+ comma-separated       list of architecture designators defined by Eclipse
+ (see Javadoc for        <tt>     org.eclipse.core.boot.BootLoader)</tt>.
+ Indicates this feature   should only    be installed on one of the specified
+ systems. If this attribute&nbsp;is     "*",  the feature can be installed
    on   all systems (portable implementation). This information is used as
  a hint   by the installation and update support (user can force installation
   of feature   regardless of this setting).</li>
-              <li> arch - optional machine architecture specification. A comma-separated
-      list of architecture designators defined by Eclipse (see Javadoc for
-       <tt>     org.eclipse.core.boot.BootLoader)</tt>. Indicates this feature
-  should only    be installed on one of the specified systems. If this attribute&nbsp;is
-     "*",  the feature can be installed on all systems (portable implementation).
-     This  information is used as a hint by the installation and update support
-     (user  can force installation of feature regardless of this setting).</li>
               <li> ws - optional windowing system specification. A comma-separated
      list  of ws designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt>
       . Indicates this feature should only be installed on one of the specified
        ws systems. If this attribute&nbsp;is "*", the feature can be installed
-       on all systems (portable implementation). This information is used
+       on all systems (portable implementation). This information is used as
- as   a  hint by the installation and update support (user can force installation
+   a  hint by the installation and update support (user can force installation
     of feature regardless of this setting).</li>
-              <li> nl - optional locale specification. A comma-separated list
+               <li> nl - optional locale specification. A comma-separated
-   of  locale   designators defined by Java. Indicates this feature should
+ list   of  locale   designators defined by Java. Indicates this feature should
- only  be installed   on a system running with a compatible locale (using
+ only  be installed   on a system running with a compatible locale (using Java
- Java locale-matching    rules). If this attribute&nbsp;is "*", the feature
+ locale-matching    rules). If this attribute&nbsp;is "*", the feature can
- can be installed on all  systems (language-neutral implementation). This
+ be installed on all  systems (language-neutral implementation). This information
- information is used as a hint by the installation and update support (user
+ is used as a hint by the installation and update support (user can force
- can force installation  of feature regardless of this setting).</li>
+ installation  of feature regardless of this setting).</li>
               <li>patch - optional specification indicating if this feature
   is  a   patch. Default is "false".&nbsp;</li>
-Line 1277
+Line 1287
    <ul>
              <li> path - required archive path identifier. This is a string
   that   is  determined  by the <a
-  href="#Feature_Archive_Mapping_Id_To_Path">feature</a>      referencing
+  href="#Feature_Archive_Mapping_Id_To_Path">feature</a>      referencing this
- this archive and is not otherwise interpreted by the site  (other   than
+ archive and is not otherwise interpreted by the site  (other   than as a
- as a lookup token).</li>
+ lookup token).</li>
               <li> url - required URL reference to the archive. Can be relative
     or  absolute.  If relative, it is relative to the location of the site.xml
     file.</li>
    </ul>
               <li> &lt;category-def&gt; - an optional definition of a category
-   that   can be used by installation and update support to hierarchicaly organize
+    that   can be used by installation and update support to hierarchicaly
-    features</li>
+ organize    features</li>
    <ul>
              <li> name - category name. Is specified as a path of name tokens
-Line 1309
+Line 1319
  <p>Translatable text contained in the site.xml can be separated into site&lt;_locale&gt;.properties
        files using Java property bundle conventions. Note that the translated
-    strings  are used at installation time (ie. do not employ the plug-in
+    strings  are used at installation time (ie. do not employ the plug-in fragment
- fragment    runtime  mechanism). The property bundles are located relative
+    runtime  mechanism). The property bundles are located relative to the
- to the site.xml    location.   </p>
+ site.xml    location.   </p>
  <h3> <a name="Default_Site_Layout"></a> Default Site Layout</h3>
              <tt>&lt;site root&gt;/</tt> <br>
-Line 1343
+Line 1353
  with   any server-side   logic support the required control mechanisms.</li>
  </ul>
-             Eclipse provides an example demonstrating an implementation of
+              Eclipse provides an example demonstrating an implementation
-  an  access    mechanism based on feature key files.
+ of  an  access    mechanism based on feature key files.
  <h2> <a name="Eclipse_Install"></a> Eclipse Install</h2>
  <h3> <a name="Default_Install_Layout"></a> Default Install Layout</h3>
-Line 1372
+Line 1382
             <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      META_INF/</tt>   </p>
- <p><b>Implementation Note:</b> we will go back to the original design of
+ <p><b>Implementation Note:</b> we will go back to the original design of not
- not splitting out fragments (ie. plugin and fragments go into the same install
+ splitting out fragments (ie. plugin and fragments go into the same install
       location) </p>
  <h3> <a name="Unmanaged_Plugins"></a> "Unmanaged" Plug-Ins</h3>
-Line 1381
+Line 1391
  plug-ins     that were directly installed into the Eclipse file tree without
  being part    of a feature (eg. developer unzipping plug-in archive directly
  into the  Eclipse  file tree).
- <p>Eclipse runtime recognizes these plugins during startup and loads the
+ <p>Eclipse runtime recognizes these plugins during startup and loads the plug-in
- plug-in information into the runtime registry following the standard plug-in
+ information into the runtime registry following the standard plug-in binding
- binding rules. The update support also recognizes the presence of this new
+ rules. The update support also recognizes the presence of this new plug-in,
- plug-in, but since this plug-in is not part of any feature it cannot be updated
+ but since this plug-in is not part of any feature it cannot be updated using
- using the update support (hence "unmanaged"). Unmanaged plug-in that become
+ the update support (hence "unmanaged"). Unmanaged plug-in that become referenced
- referenced by a feature as a result of some future installation or update
+ by a feature as a result of some future installation or update action become
- action become "managed" (can be updated as part of the feature). </p>
+ "managed" (can be updated as part of the feature). </p>
  <p>Unmanaged plug-ins are not displayed as part of the installation and update
       UI. </p>
-Line 1395
+Line 1405
  <h3> <a name="Using_Native_Platform_Installers"></a> Using Native Platform
       Installers</h3>
              The Eclipse installation contains plugins that can be shared
- across    multiple   features. When installing and uninstalling features
+ across    multiple   features. When installing and uninstalling features using
- using the   Eclipse installation   and update support, these relationship
+ the   Eclipse installation   and update support, these relationship are correctly
- are correctly   maintained. Only one   copy of any version of a plug-in is
+   maintained. Only one   copy of any version of a plug-in is used.
- used.
  <p>However, when using native platform installers, performing native uninstall
        creates problems because plug-ins would be removed without regard to
   any    sharing relationships. As a result, Eclipse <b>does not allow</b>
  plug-ins    to be installed using native installers into the shared installation
  tree.    Instead, native installers must establish their own installation
- root directory.    The subdirectory structure is the same as defined for
+ root directory.    The subdirectory structure is the same as defined for base
- base Eclipse. The  private  root directory is logically linked into the shared
+ Eclipse. The  private  root directory is logically linked into the shared
    Eclipse installation   via  a link file installed by the native installer.
    The file path for the   link  file is <tt>&lt;configRoot&gt;/links/</tt>.
    The <tt>&lt;configRoot&gt;   </tt>  location is computed by Eclipse relative
    to the launch <a href="#Multiple%20Launch%20Points"> configuration file</a>
-   . By default,    this is the <tt>install/</tt> directory in the shared
+   . By default,    this is the <tt>install/</tt> directory in the shared Eclipse
- Eclipse   installation    tree. </p>
+   installation    tree. </p>
  <p>The name of the link file is not specified by Eclipse. The name is determined
        by the native installer. To minimize the potential for naming collisions,
        it is recommended that the file name contain the identifier and version
-     of the feature being installed by the native installer. For example,
+     of the feature being installed by the native installer. For example, <tt>&lt;featureId&gt;_&lt;featureVersion&gt;.properties</tt>
- <tt>&lt;featureId&gt;_&lt;featureVersion&gt;.properties</tt>      . The file
+      . The file content is in the form of a Java properties file, with the
- content is in the form of a Java properties file, with the  following
+  following    properties defined: </p>
- properties defined: </p>
  <p><tt>path=[r|rw] install-path[,[r|rw] install-path]*</tt> </p>
-Line 1431
+Line 1440
    Default is to  allow updates&nbsp; (w). </p>
  <p>Eclipse does not manage the linked directories in any way. It simply detects
-      their existence by the presence of the link files, and includes the linked
+       their existence by the presence of the link files, and includes the
-      plug-ins during the platform startup. The native installer is responsible
+ linked      plug-ins during the platform startup. The native installer is
-      for uninstalling the link when the corresponding directory is removed.
+ responsible      for uninstalling the link when the corresponding directory
-   Eclipse   runtime ignores any links that cannot be resolved. <br>
+ is removed.   Eclipse   runtime ignores any links that cannot be resolved.
+ <br>
             &nbsp; </p>
             <br>
            <br>
-Line 1444
+Line 1454
        <br>
          <br>
   <br>
+  <br>
  </body>
  </html>

 Legend:



Removed from v.1.16
 


changed lines


 
Added in v.1.17
 Legend:



Removed from v.1.16
 


changed lines


 
Added in v.1.17
-Removed from v.1.16
+Added in v.1.17

help@eclipse.org	ViewVC Help
Powered by ViewVC 1.0.3