[Yanel-dev] Re: [Dev] Re: Yanel in Eclipse

[Mehmet Birgi]

Hi All

If there is no more feedback, I will check in this current version later
today.

Cheers,

Memo



On Thu, Mar 18, 2010 at 3:53 PM, Mehmet Birgi <mehmet.birgi at wyona.com>wrote:

> Thanks to Guillaume for providing excellent feedback, here is the second
> draft, with his suggestions incorporated (I'm still open to more feedback=
):
>
>
> Setting up Yanel in the Eclipse IDE
>
> This document will get you started using Eclipse to develop/debug your
> Yanel project. To keep things simple and reliable, building and SVN access
> will be done outside of Eclipse. Also, it is assumed that you are using a
> unix-like shell for command line processing, if you are using the windows
> command line, replace the references to the shell scripts below with their
> aequivalent dos batch files (e.g. replace "build.sh" with "build.bat") and
> "/" with "\".
>
> Depending on what you will be working on, you might need to import several
> projects into Eclipse. In this context, there are 3 types of projects:
> realms, resources, and Yanel itself. Please note that importing Yanel into
> Eclipse as a project will *not* automatically import Yanel's resource
> types, they have to be imported separately, and one by one, as described
> below.
> Importing a realm
>
> If you want to work on a realm that has a separate directory from the Yan=
el
> source, follow these steps to import it as a project into Eclipse:
>
>    1. Check out Yanel and the external realm, and add the realm to Yanel<=
http://127.0.0.1:8080/yanel/yanel-website/en/documentation/how-to-add-a-new=
-realm.html>
>    .
>    2. Compile and deploy "yanel-test-1.0-dev-rREVISION.jar":
>
>    cd {path/to/yanel/root}
>    ./build.sh -f {path/to/yanel/root}/src/test/build.xml install-jar
>
>    This will build the jar file and deploy it automatically to your maven
>    repository.
>     3. Build an Eclipse project using the specific "eclipse" target with
>    the realm's build file:
>
>    cd {path/to/yanel/root}
>    ./build.sh -f {path/to/realm/root}/build.xml eclipse
>
>    4. In Eclipse, select *File -> Import*, to open the Import dialog.
>    5. Select *General -> Existing Projects into Workspace*, then click on
>    *Next*.
>    6. Check *"Select root directory"*, click on *Browse*, and select the
>    realm's root directory (i.e. where build.xml is located)
>    7. Make sure the realm project is selected (should be the only one), *=
"Copy
>    projects into workspace"* is *not* selected, and click on *Finish*.
>
> The realm should now be visible as a project in the Package Explorer view
> in Eclipse's Java perspective.
> Importing resource types
>
> If you want to work on a specific resource type that is either a resource
> type of Yanel, or one belonging to another realm, follow these steps to
> import it as a project into Eclipse:
>
>    1. Follow points #1-2<http://127.0.0.1:8080/yanel/yanel-website/en/doc=
umentation/development/build_setup_eclipse_ide.html#point1>above if you hav=
e not already done so.
>    2. If the resource type you are importing belongs to an external realm,
>    follow point #3<http://127.0.0.1:8080/yanel/yanel-website/en/documenta=
tion/development/build_setup_eclipse_ide.html#point3>above in case you have=
 not already done so. If the resource type you are
>    importing belongs to Yanel, build an Eclipse project using the specific
>    "eclipse" target with the resource's build file:
>
>    cd {path/to/yanel/root}
>    ./build.sh -f {path/to/yanel/root}/src/.../{resource-directory}/build.=
xml eclipse
>
>    3. In Eclipse, select *File -> Import*, to open the Import dialog.
>    4. Select *General -> Existing Projects into Workspace*, then click on
>    *Next*.
>    5. Check *"Select root directory"*, click on *Browse*, and select
>    either a directory containing all the resource-types of your realm (th=
ey may
>    be imported all at once), or the directory of the Yanel resource that =
you
>    want to import ({path/to/yanel/root}/src/.../{resource-directory}, in =
this
>    case you have to import them one by one).
>    6. Select the resources that you want to import as projects, make sure
>    *"Copy projects into workspace"* is *not* selected, and click on *
>    Finish*.
>
> The resources should now be visible as projects in the Package Explorer
> view in Eclipse's Java perspective.
> Importing Yanel
>
>    1. Check out and build Yanel as usual<http://yanel.org/download/source=
-repository.html>,
>    if you have not yet done so.
>    2. Build an Eclipse project using the specific target "eclipse":
>
>    cd {path/to/yanel/root}
>    ./build.sh eclipse
>
>    3. In Eclipse, select *File -> Import*, to open the Import dialog.
>    4. Select *General -> Existing Projects into Workspace*, then click on
>    *Next*.
>    5. Check *"Select root directory"*, click on *Browse*, and select the
>    Yanel root directory (i.e. where build.sh is located)
>    6. Make sure the Yanel project is selected (should be the only one), *=
"Copy
>    projects into workspace"* is *not* selected, and click on *Finish*.
>
> The project "yanel" should now be visible in the Package Explorer view in
> Eclipse's Java perspective.
> Debugging
>
> To start debugging with Eclipse, start Tomcat in debug mode:
>
> {path/to/yanel/root}/local/apache-tomcat-5.5.20/bin/catalina.sh jpda start
>
> Alternatively, you can (theoretically) also use the Eclipse Tomcat Launch=
er
> or other Tomcat plugins. If you succeed in this, please document it here,=
 or
> send a description to the Yanel developers mailing list<http://yanel.wyon=
a.org/mailing-lists.html>
> .
> Notes
>
> Windows users, please configure your line endings as LF by setting *Prefe=
rences
> -> General -> Workspace -> New text file line delimiter* to *"Unix"*.
>
> ------------------------------
>
> TODO: Document how to create a debug configuration andhow to debug across
> multiple resource-types, which may still be tricky.
>
>
>
>
>


-- =

Mehmet Birgi
www.wyona.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.wyona.org/pipermail/yanel-development/attachments/2010032=
2/fa4d8e53/attachment.htm