[Jboss-svn-commits] JBL Code SVN: r4242 - labs/jbossrules/trunk/documentation/manual/en/Chapter-Install

[<jbo...@li...>]

Author: mic...@jb...
Date: 2006-05-16 02:28:53 -0400 (Tue, 16 May 2006)
New Revision: 4242

Modified:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml
Log:
update site doco

Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml	2006-05-16 05:41:08 UTC (rev 4241)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml	2006-05-16 06:28:53 UTC (rev 4242)
@@ -136,19 +136,6 @@
     <para>The drools-ide project was checked out out using subversion and is
     ready for exporting.</para>
 
-    <para>NOTE: there is also an update site for the plug in. For developers
-    who want to update the update site (ha) you will need to open the feature
-    project, and the site project. They are kept in SVN, but in
-    /jbossrules/update instead of /trunk. They are plain vanilla eclipse
-    feature and site projects, so refreshing them should be self explanatory
-    should you need to do it.</para>
-
-    <para>Should this be problematic, the drools-ide-update project can be
-    manually edited - change the version number in the site.xml, and then
-    change it in the feature.xml which is embedded in the /features/*.jar
-    file. Then place the updated plug in in the /plugins directory (with the
-    same file name as the /features jar file).</para>
-
     <screenshot>
       <screeninfo>Select Export on the drools-ide project</screeninfo>
 
@@ -237,4 +224,78 @@
       </mediaobject>
     </screenshot>
   </section>
+
+  <section>
+    <title>Building the update site</title>
+
+    <para>There is also an update site for the plug in. For developers who
+    want to update the update site (ha) you will need to get to the update
+    site project (or create a new one). They are kept in SVN, but in
+    /jbossrules/update instead of /trunk. They are plain vanilla eclipse
+    feature and site projects.</para>
+
+    <para>Eclipse refreshing plugins in features and sites seems to not work,
+    so what is best is to manually edit the site.xml project and the
+    feature.xml. To do this, open the site.xml file in the drools-ide-update
+    project, it should look something like this: <programlisting>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;site&gt;
+   &lt;!-- change both the jar and the version number, make sure the new features jar is named
+        the same as what you put in --&gt;
+   &lt;feature url="features/org.drools.ide_1.0.2.jar" id="org.drools.ide" version="1.0.2"&gt;
+  &lt;category name="JBossRules"/&gt;
+   &lt;/feature&gt;
+   &lt;category-def name="JBossRules" label="JBoss Rules"/&gt;
+&lt;/site&gt;
+</programlisting> Change the version attribute to be something new, and also
+    the name of the feature jar to have a new version number at the
+    end.</para>
+
+    <para>Go into the /feature directory, and unzip the feature jar to get to
+    the feature.xml. (the feature jar really just contains the feature.xml).
+    Open the feature.xml, and it should look like: <programlisting>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;feature
+  id="org.drools.ide"
+  label="Drools Rule Workbench"
+  version="1.0.2"&gt; &lt;!-- UPDATE THIS !! --&gt;
+
+   &lt;description&gt;
+  JBoss Rules (Drools) Workbench for developers.
+   &lt;/description&gt;
+
+   &lt;copyright&gt;
+  Copyright 2005 JBoss Inc
+   &lt;/copyright&gt;
+
+   &lt;license&gt;
+  Licensed under the Apache License, Version 2.0(the &amp;quot;License&amp;quot;);
+ you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+  
+   http://www.apache.org/licenses/LICENSE-2.0
+  
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an &amp;quot;AS IS&amp;quot; BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+   &lt;/license&gt;
+
+   &lt;plugin
+ id="org.drools.ide"
+ download-size="0"
+ install-size="0"
+ version="1.0.0"/&gt; &lt;!-- THIS JUST HAS TO BE CONSISTENT WITH THE PLUG IN --&gt;
+
+&lt;/feature&gt;
+</programlisting> Change the version number in the FEATURE tag to be the same
+    as what you referred to in the site.xml. If you changed the version number
+    of the main plug in, you will need to put the version number in the plug
+    in tag (which refers to org.drools.ide plugin). Then zip up the
+    feature.xml into a jar with the same name as you referred to in the
+    site.xml.</para>
+
+    <para>Finally, drop the plugin jar into the /plugins jar directory of the
+    update site. Now you can upload the site as is, and it will show up as a
+    new version for Eclipse clients.</para>
+  </section>
 </section>
\ No newline at end of file