svn commit: r559542 - /incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.javadocs.xml

[sc...@apache.org]

Author: schor
Date: Wed Jul 25 11:01:20 2007
New Revision: 559542

URL: http://svn.apache.org/viewvc?view=rev&rev=559542
Log:
[UIMA-499] add doc to JavaDocs chapter on how to use
Eclipse user-libraries when doing javadoc attachments

Modified:
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.javadocs.xml

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.javadocs.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.javadocs.xml?view=diff&rev=559542&r1=559541&r2=559542
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.javadocs.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.javadocs.xml Wed Jul 25 11:01:20 2007
@@ -56,8 +56,26 @@
     OpenExternalJavaDoc, or open the Javadoc view (Window → Show View → Other
     &rarr; Java &rarr; Javadoc).</para>
   
-  <para>In a similar manner, you can attach the source for the UIMA framework. The source corresponding to particular
+  <para>In a similar manner, you can attach the source for the UIMA framework, if you download the source
+    distribution. The source corresponding to particular
     releases is available from the Apache UIMA web site (<ulink url="http://incubator.apache.org/uima"/>) on the
     downloads page.</para>
   
+  <section id="ugr.ref.javadocs.libraries">
+    <title>Using named Eclipse User Libraries</title>
+  <para>You can also create a named "user library" in Eclipse containing the UIMA Jars, and attach the JavaDocs (or
+  optionally, the sources); this named library is saved in the Eclipse workspace.  Once created, it can be
+  added to the classpath of newly created Eclipse projects.</para> 
+  
+  <para>Use the menu option Project &rarr; Properties
+  &rarr; Java Build Path, and then pick the Libraries tab, and click the Add Library button. Then select
+  User Libraries, click "Next", and pick the library you created for the UIMA Jars.</para> 
+  
+  <para>To create this library in the workspace,
+    use the same menu picks as above, but after you select the User Libraries and click "Next", you can click the "New Library..."
+    button to define your new library.  You use the "Add Jars" button and multi-select all the Jars in the lib directory
+    of the UIMA binary distribution.  Then you add the JavaDoc attachment for each Jar.  The path to use is
+    file:/ -- insert the path to your install of UIMA -- /docs/api.  After you do this for the first Jar, you can
+    copy this string to the clipboard and paste it into the rest of the Jars.</para>
+    </section>
 </chapter>