![]() |
|
|||
![]() |
![]() |
![]() |
||
IntroductionThe Kelp add-in makes it easy to use the Enhydra XML Compiler (XMLC) and the Enhydra Application Server within an integrated development environment. Kelp 5.0 supports Borland JBuilder 4, 5, 6 and 7, NetBeans 3.3.1. and 3.3.2. and JDeveloper 3.2.3. Refer to Using Kelp with an IDE for information on how to use a Kelp add-in to develop web applications with XMLC. This document supplements documentation for Kelp tools and add-ins. You'll also find an overview of the open source CVS modules at the end of this document. You will find more details about earlier versions of Kelp at the Enhydra Kelp project web site along with FAQs (Frequently Asked Questions) and information on checking out the source from the CVS repository. This documentation assumes a basic understanding of a Java IDE and the servlet programming model. For information on JBuilder, visit the Borland website. The add-in provides wizards and tools to help you develop applications for Aonyx5.0. The add-in will add the Kelp application wizards to your IDE's File menu. You only need to use an application wizard when starting a new project. If you have an existing application that uses the Enhydra 3 make system, you can import it into an IDE project file using the Enhydra Import wizard. Once you have a project, you can use the XML Compiler and Kelp Deployer to build and deploy your application. The XML Compiler and Kelp Deployer are added to the IDE's Tools menu. These tools give you access to Enhydra features from within your IDE. Using the JBuilder integrated build feature, you can invoke these same processes directly within the project builder without opening either wizard. Each tool also has a set of project and node property pages that you can access from your project navigation tree. The general usage model for building web applications with the Kelp add-in:
The general usage model for building Enhydra applications with the Kelp add-in:
The Kelp Project Web SiteThe Kelp project web site, http://kelp.enhydra.org is dedicated to making Enhydra technologies easier to use through the use of tools such as application wizards and Java IDE add-ons. The site serves as the repository for downloads, documentation and mail list archives. It also acts as a gateway to the CVS repository for the open source modules. You can use the project mail list, kelp@enhydra.org to post questions or suggestions regarding any of the Kelp modules. View the mail list archive to get information on recent releases and tips on how to make the most of Kelp.You are invited to participate in the Kelp project. We welcome contributions in many forms, including documentation, patches and additional IDE implementations. Installing the add-in from kelp.enhydra.orgBefore installing the add-in, you should already have installed a supported Java IDE and the Enhydra Application Server. System Requirements
Kelp 5 requires the Kelp add-in jar, the Kelp toolbox jar and Enhydra XMLC classes to be in the IDE class path. Note that Kelp 5 will not work with Enhydra 3.1. It is recommended that you go through each step listed in the installation guide so you can run the Enhydra administration console. If you install your Java IDE prior to installing Enhydra, you can skip the step about downloading Java. You can configure the application server to work with the Java 2 files that come with the IDE.
Install OptionsKelp add-ins are available in the following packages:Upgrading from Kelp 2 or Enhydra 3.xIf you have configured your IDE for use with earlier releases of Kelp or the Enhydra application server, you should uninstall and remove all references to those releases. This is particularly important if you plan to use a configure script or the Windows installer to configure your IDE. The following items provide steps that should be taken prior to installing Kelp 5.0 Configuring your IDEYou will need to modify some IDE configuration files to enable the Kelp add-in. The configuration process depends on what IDE you are running. Refer to the steps for your IDE. After configuring your IDE, you can to create an Enhydra library to use with your Enhydra projects. The library should include the Enhydra classes required to compile the source files generated by XMLC. For usage information run the configure script without any parameters from the kelp5 directory. Follow the steps below when you manually install Kelp 5.0 or if the add-in does not appear to be functioning properly after using the Windows installer or the configure script. If you want to use the XML Compiler with non-HTML document types on
Linux, you will also need to comment out the You can check to see if you have installed the tools correctly by starting JBuilder and looking for the XML Compiler in the Tools menu. If the menu does not appear, check the IDE class path setting from the Info tab of the JBuilder about box. The add-in includes a installer that automates the configuration process when installing into NetBeans 3.3.1.or 3.3.2. It will setup Kelp add-in and add libraries to IDE classpath. Follow the steps below if the add-in does not appear to be functioning properly after using the installer, or if you want to manualy install add-in. Note that when manually configuring NetBeans, you will be modifying your existing configuration files instead of using the Kelp provided installer. Configuring your IDE Add the toolbox.jar, enhydra.jar, xmlc.jar, xerces.jar, tomcat.jar, core.jar, xhtml.jar, wireless.jar and gnu-regexp.jar to your IDE class path. NetBeans includes a configuration file that you can use to add jars to the IDE class path.For installing KELP in JDeveloper, JDeveloper configuration file have Defining a project class pathIn JBuilder, the project class path is independent of the IDE class path. Both IDEs also allow you to define sets of jars as libraries. Libraries may be shared between projects. The following jars are required to successfully compile and run projects that use the servlet, Enhydra application or Enhydra XMLC.
ToolBox properties The IDE add-in uses wizards within the ToolBox library. The ToolBox
persists user settings in a toolbox.properties file. This file is created
in an /home/toni/.enhydra/toolbox.properties
If you experience any problems using the application wizards, verify that you have rights to create files and directories within your home directory. Using the installer applicationYou can use the open source installer to install Kelp add-in files and configure your IDE. The setup program will look up your Java IDE home directory in the Windows registry. If you have installed more than one supported IDE, you may need to click on Browse in the Choose IDE directory step to select the location of the IDE you want to use with Enhydra. The sample projects, documentation and libraries will be installed in a kelp5 directory within the Java IDE's home directory. After selecting the Java IDE root directory to use for installing, you need to tell the setup program where your Enhydra root directory is located. The setup program will look for a lib directory containing one or more Enhydra jar files within your Enhydra root directory. The setup program will check the Windows registry and common locations to determine a default such as: c:\Aonyx5.0 Enter the correct location or use Browse to navigate to your Enhydra root directory. The Enhydra jar files will be added to the IDE class path. The setup program also creates an Enhydra library for use with your projects. The toolbox.jar will also be installed. After selecting the type of installation you want, setup prompts you for the program group and lists all your selections for confirmation. When you confirm the settings, the installer will copy files into a kelp5 directory within the IDE home directory. The installer also copies the toolbox.jar to <aonyx5.0_root>/lib/build. The installer modifies IDE configuration files. Some of the modifications will not be reversed if you uninstall Kelp. To allow you to restore your original configuration, the setup program creates a backup of each of the modified files and copies the backups to the kelp5 directory. JBuilder automatically detects and loads add-ins from the jar files that are listed in the IDE class path. It checks the manifest of each jar in the IDE class path to see if it contains a loadable add-in. If you want to know more about what the installer does to update your IDE configuration, refer to the section configuring your IDE. CVS modulesThe source files for the Kelp ToolBox and add-in modules are available from the CVS page of the Kelp project web site. Each module contains an Ant build.xml file. Some of the modules also contain JBuilder projects that you can use to view, debug and build the source. Kelp includes the following modules.
In Kelp 5.0 only toolbox, AddinCore, AddinJBuilder6, AddinJBuilder7, AddinJDeveloper and KelpAddinForte modules can be built with Jakarta Ant 1.5 provided that you have setup the class paths in each modules lib.properties file.
|