Eclipse: Set up project and example extension from git sources

2024-07-12T13:23:10Z

Edso: /* Create run/debug configuration */

== Download and install eclipse (if not already available) ==
; Download and unzip from
: https://www.eclipse.org/downloads/packages/
: either
:: Package for Enterprise Java and Web Developers
:: Package for Java Developers
: each will do fine for OJ development

All the below was tested with eclipse version 2024.06.

== OpenJUMP project ==

=== Import into eclipse IDE ===
'''NOTE:''' The file system paths below are for windows but can analogous be some unix/linux/mac paths.
# Start the eclipse application
# Create and open a new workspace e.g. ''C:\workspace-OpenJUMP''
# File > Import...
## Git > Projects from Git (with smart import) ; Next>
## Clone URI ; Next>
## enter URI ''https://github.com/openjump-gis/openjump.git'' ; Next>
## make sure at least branch ''main'' is selected ; Next>
## choose a location for the project folder e.g. ''C:\workspace-OpenJUMP\OpenJUMP'' ; Next>
## eclipse will now clone the git repository into the project folder
# Import Projects dialog pops up
## Folder ''OpenJUMP'' should be preselected '''Import as Maven'''
## Finish>
eclipse should now build the maven project without errors (warnings can be ignored)

=== Create run/debug configuration ===
When the project builds fine you will need to provide some information to be able to run OJ directly from the built project.
# '''Run > Run Configurations...'''
## Right click '''Java Application''' on the left side ; Select '''New Configuration'''
## change '''Name''' above tabs from ''New Configuration'' to ''OpenJUMP''
## tab '''Main'''
### make sure '''Project''' is ''OpenJUMP''
### add '''Main Class''' ''com.vividsolutions.jump.workbench.JUMPWorkbench''
## tab '''Arguments'''
### add '''Program arguments''' ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -extensions-directory "target\lib.ext.core" -extensions-directory "target\lib.ext.plus" -I18n en_US -v info'' '''NOTE:''' you can change the language/region with the parameter '''-I18n''' or raise the log verbosity to debug with '''-v''' or remove ''-extensions-directory "target\lib.ext.plus"'' to simulate OJ CORE
### add '''VM arguments''' ''-Djava.system.class.loader=com.vividsolutions.jump.workbench.plugin.PlugInClassLoader''
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and be able to do so in the future. you can also debug OJ by selecting the created run configuration under '''Run > Debug Configurations...''' . 
there are also handy buttons on the toolbar available to do so quickly. note the small downward arrows beside them!

== HelloWorld extension ==

OJ extension projects usually are managed/build by maven. Extensions bundle/initialize/install plugins. [[The difference of PlugIn and Extension and Registry|Here's a quick explanation.]]

Maven also packages them into self contained distribution jar files that can be placed under 'lib/ext/' in your OJ installation to be used. In case the extension needs additional (not-jar) files the distribution is done as zip file containing jars and files/folder to be placed under 'lib/ext/'.

Strictly speaking a checkout of the complete OJ sources is not needed to develop an extension. It is perfectly possible to do so against an OJ portable distribution. We may document that later in case somebody requests it.

=== Import project ===

generally you repeat all steps from [[#Import into eclipse IDE|Import OJ into eclipse]] above.
but this time use
# URI ''https://github.com/openjump-gis/helloworld-extension.git''
# Folder name ''HelloWorld-Extension''
let the import finish and build.

=== Create run/debug configuration ===

same here. running OJ with the extension included utilizes the [[#Create run/debug configuration|basic run/debug configuration created above]]. we will duplicate it and add some command line parameters for the OJ plugin loader to find and load the extension classes/files during runtime.

simply put - we will remove the folders to look for additional extensions but provide a new one where the extensions classes are compiled to. additionally we use ''-limit-ext-lookup false'' to have OJ not only to look into jar files but additionally recurse through all folders and look for extension class files as well.

# Run > Run Configurations...
## expand '''Java Application''' on the left side; Right click '''OpenJUMP'''; Select '''Duplicate'''
## a new configuration '''OpenJUMP (1)''' will be created
## edit this configuration
## change '''Name''' above tabs from ''OpenJUMP (1)'' to ''HelloWorld''
## tab '''Arguments'''
### change '''Program arguments''' to ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -I18n en_US -v info -limit-ext-lookup false -extensions-directory ${workspace_loc:helloworld-extension}/target/classes'' '''NOTE:''' we removed ''target/lib.ext.core,plus'' as the other extensions are not strictly needed to develop an extension, they slow down startup and clutter the interface. you may add those later to test incompatibilities against them later though.
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and the HelloWorld extension should show up under Plugins > Example.

Eclipse: Set up project and example extension from git sources

2024-07-12T13:22:41Z

Edso: /* Create run/debug configuration */

== Download and install eclipse (if not already available) ==
; Download and unzip from
: https://www.eclipse.org/downloads/packages/
: either
:: Package for Enterprise Java and Web Developers
:: Package for Java Developers
: each will do fine for OJ development

All the below was tested with eclipse version 2024.06.

== OpenJUMP project ==

=== Import into eclipse IDE ===
'''NOTE:''' The file system paths below are for windows but can analogous be some unix/linux/mac paths.
# Start the eclipse application
# Create and open a new workspace e.g. ''C:\workspace-OpenJUMP''
# File > Import...
## Git > Projects from Git (with smart import) ; Next>
## Clone URI ; Next>
## enter URI ''https://github.com/openjump-gis/openjump.git'' ; Next>
## make sure at least branch ''main'' is selected ; Next>
## choose a location for the project folder e.g. ''C:\workspace-OpenJUMP\OpenJUMP'' ; Next>
## eclipse will now clone the git repository into the project folder
# Import Projects dialog pops up
## Folder ''OpenJUMP'' should be preselected '''Import as Maven'''
## Finish>
eclipse should now build the maven project without errors (warnings can be ignored)

=== Create run/debug configuration ===
When the project builds fine you will need to provide some information to be able to run OJ directly from the built project.
# Run > Run Configurations...
## Right click '''Java Application''' on the left side ; Select '''New Configuration'''
## change '''Name''' above tabs from ''New Configuration'' to ''OpenJUMP''
## tab '''Main'''
### make sure '''Project''' is ''OpenJUMP''
### add '''Main Class''' ''com.vividsolutions.jump.workbench.JUMPWorkbench''
## tab '''Arguments'''
### add '''Program arguments''' ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -extensions-directory "target\lib.ext.core" -extensions-directory "target\lib.ext.plus" -I18n en_US -v info'' '''NOTE:''' you can change the language/region with the parameter '''-I18n''' or raise the log verbosity to debug with '''-v''' or remove ''-extensions-directory "target\lib.ext.plus"'' to simulate OJ CORE
### add '''VM arguments''' ''-Djava.system.class.loader=com.vividsolutions.jump.workbench.plugin.PlugInClassLoader''
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and be able to do so in the future. you can also debug OJ by selecting the created run configuration under '''Run > Debug Configurations...''' . 
there are also handy buttons on the toolbar available to do so quickly. note the small downward arrows beside them!

== HelloWorld extension ==

OJ extension projects usually are managed/build by maven. Extensions bundle/initialize/install plugins. [[The difference of PlugIn and Extension and Registry|Here's a quick explanation.]]

Maven also packages them into self contained distribution jar files that can be placed under 'lib/ext/' in your OJ installation to be used. In case the extension needs additional (not-jar) files the distribution is done as zip file containing jars and files/folder to be placed under 'lib/ext/'.

Strictly speaking a checkout of the complete OJ sources is not needed to develop an extension. It is perfectly possible to do so against an OJ portable distribution. We may document that later in case somebody requests it.

=== Import project ===

generally you repeat all steps from [[#Import into eclipse IDE|Import OJ into eclipse]] above.
but this time use
# URI ''https://github.com/openjump-gis/helloworld-extension.git''
# Folder name ''HelloWorld-Extension''
let the import finish and build.

=== Create run/debug configuration ===

same here. running OJ with the extension included utilizes the [[#Create run/debug configuration|basic run/debug configuration created above]]. we will duplicate it and add some command line parameters for the OJ plugin loader to find and load the extension classes/files during runtime.

simply put - we will remove the folders to look for additional extensions but provide a new one where the extensions classes are compiled to. additionally we use ''-limit-ext-lookup false'' to have OJ not only to look into jar files but additionally recurse through all folders and look for extension class files as well.

# Run > Run Configurations...
## expand '''Java Application''' on the left side; Right click '''OpenJUMP'''; Select '''Duplicate'''
## a new configuration '''OpenJUMP (1)''' will be created
## edit this configuration
## change '''Name''' above tabs from ''OpenJUMP (1)'' to ''HelloWorld''
## tab '''Arguments'''
### change '''Program arguments''' to ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -I18n en_US -v info -limit-ext-lookup false -extensions-directory ${workspace_loc:helloworld-extension}/target/classes'' '''NOTE:''' we removed ''target/lib.ext.core,plus'' as the other extensions are not strictly needed to develop an extension, they slow down startup and clutter the interface. you may add those later to test incompatibilities against them later though.
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and the HelloWorld extension should show up under Plugins > Example.

Eclipse: Set up project and example extension from git sources

2024-07-12T13:21:34Z

Edso: /* Create run/debug configuration */

== Download and install eclipse (if not already available) ==
; Download and unzip from
: https://www.eclipse.org/downloads/packages/
: either
:: Package for Enterprise Java and Web Developers
:: Package for Java Developers
: each will do fine for OJ development

All the below was tested with eclipse version 2024.06.

== OpenJUMP project ==

=== Import into eclipse IDE ===
'''NOTE:''' The file system paths below are for windows but can analogous be some unix/linux/mac paths.
# Start the eclipse application
# Create and open a new workspace e.g. ''C:\workspace-OpenJUMP''
# File > Import...
## Git > Projects from Git (with smart import) ; Next>
## Clone URI ; Next>
## enter URI ''https://github.com/openjump-gis/openjump.git'' ; Next>
## make sure at least branch ''main'' is selected ; Next>
## choose a location for the project folder e.g. ''C:\workspace-OpenJUMP\OpenJUMP'' ; Next>
## eclipse will now clone the git repository into the project folder
# Import Projects dialog pops up
## Folder ''OpenJUMP'' should be preselected '''Import as Maven'''
## Finish>
eclipse should now build the maven project without errors (warnings can be ignored)

=== Create run/debug configuration ===
When the project builds fine you will need to provide some information to be able to run OJ directly from the built project.
# Run > Run Configurations...
## Right click '''Java Application''' on the left side ; Select '''New Configuration'''
## change '''Name''' above tabs from ''New Configuration'' to ''OpenJUMP''
## tab '''Main'''
### make sure '''Project''' is ''OpenJUMP''
### add '''Main Class''' ''com.vividsolutions.jump.workbench.JUMPWorkbench''
## tab '''Arguments'''
### add '''Program arguments''' ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -extensions-directory "target\lib.ext.core" -extensions-directory "target\lib.ext.plus" -I18n en_US -v info'' '''NOTE:''' you can change the language/region with the parameter '''-I18n''' or raise the log verbosity to debug with '''-v''' or remove ''-extensions-directory "target\lib.ext.plus"'' to simulate OJ CORE
### add '''VM arguments''' ''-Djava.system.class.loader=com.vividsolutions.jump.workbench.plugin.PlugInClassLoader''
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and be able to do so in the future. you can also debug OJ by selecting the created run configuration under '''Run > Debug Configurations...''' . 
there are also handy buttons on the toolbar available to do so quickly. note the small downward arrows beside them!

== HelloWorld extension ==

OJ extension projects usually are managed/build by maven. Extensions bundle/initialize/install plugins. [[The difference of PlugIn and Extension and Registry|Here's a quick explanation.]]

Maven also packages them into self contained distribution jar files that can be placed under 'lib/ext/' in your OJ installation to be used. In case the extension needs additional (not-jar) files the distribution is done as zip file containing jars and files/folder to be placed under 'lib/ext/'.

Strictly speaking a checkout of the complete OJ sources is not needed to develop an extension. It is perfectly possible to do so against an OJ portable distribution. We may document that later in case somebody requests it.

=== Import project ===

generally you repeat all steps from [[#Import into eclipse IDE|Import OJ into eclipse]] above.
but this time use
# URI ''https://github.com/openjump-gis/helloworld-extension.git''
# Folder name ''HelloWorld-Extension''
let the import finish and build.

=== Create run/debug configuration ===

same here. running OJ with the extension included utilizes the [[#Create run/debug configuration|basic run/debug configuration created above]]. we will duplicate it and add some command line parameters for the OJ plugin loader to find and load the extension classes/files during runtime.

simply put - we will remove the folders to look for additional extensions but provide a new one where the extensions classes are compiled to. additionally we use ''-limit-ext-lookup false'' to have OJ not only to look into jar files but additionally recurse through all folders and look for extension class files as well.

# Run > Run Configurations...
## expand '''Java Application''' on the left side; Right click '''OpenJUMP'''; Select '''Duplicate'''
## a new configuration '''OpenJUMP (1)''' will be created
## edit this configuration
## change '''Name''' above tabs from ''OpenJUMP (1)'' to ''HelloWorld''
## tab '''Arguments'''
### change '''Program arguments''' to ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -I18n en_US -v info -limit-ext-lookup false -extensions-directory ${workspace_loc:helloworld-extension}/target/classes'' '''NOTE:''' we removed ''target/lib.ext.core,plus'' as the other extensions are not strictly needed to develop an extension, they slow down startup and clutter the interface. you may add those later to test incompatibilities against them later though.
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and the HelloWorld extension should show up under Plugins->Example.

Eclipse: Set up project and example extension from git sources

2024-07-12T13:15:43Z

Edso: /* Import project */

== Download and install eclipse (if not already available) ==
; Download and unzip from
: https://www.eclipse.org/downloads/packages/
: either
:: Package for Enterprise Java and Web Developers
:: Package for Java Developers
: each will do fine for OJ development

All the below was tested with eclipse version 2024.06.

== OpenJUMP project ==

=== Import into eclipse IDE ===
'''NOTE:''' The file system paths below are for windows but can analogous be some unix/linux/mac paths.
# Start the eclipse application
# Create and open a new workspace e.g. ''C:\workspace-OpenJUMP''
# File > Import...
## Git > Projects from Git (with smart import) ; Next>
## Clone URI ; Next>
## enter URI ''https://github.com/openjump-gis/openjump.git'' ; Next>
## make sure at least branch ''main'' is selected ; Next>
## choose a location for the project folder e.g. ''C:\workspace-OpenJUMP\OpenJUMP'' ; Next>
## eclipse will now clone the git repository into the project folder
# Import Projects dialog pops up
## Folder ''OpenJUMP'' should be preselected '''Import as Maven'''
## Finish>
eclipse should now build the maven project without errors (warnings can be ignored)

=== Create run/debug configuration ===
When the project builds fine you will need to provide some information to be able to run OJ directly from the built project.
# Run > Run Configurations...
## Right click '''Java Application''' on the left side ; Select '''New Configuration'''
## change '''Name''' above tabs from ''New Configuration'' to ''OpenJUMP''
## tab '''Main'''
### make sure '''Project''' is ''OpenJUMP''
### add '''Main Class''' ''com.vividsolutions.jump.workbench.JUMPWorkbench''
## tab '''Arguments'''
### add '''Program arguments''' ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -extensions-directory "target\lib.ext.core" -extensions-directory "target\lib.ext.plus" -I18n en_US -v info'' '''NOTE:''' you can change the language/region with the parameter '''-I18n''' or raise the log verbosity to debug with '''-v''' or remove ''-extensions-directory "target\lib.ext.plus"'' to simulate OJ CORE
### add '''VM arguments''' ''-Djava.system.class.loader=com.vividsolutions.jump.workbench.plugin.PlugInClassLoader''
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and be able to do so in the future. you can also debug OJ by selecting the created run configuration under '''Run > Debug Configurations...''' . 
there are also handy buttons on the toolbar available to do so quickly. note the small downward arrows beside them!

== HelloWorld extension ==

OJ extension projects usually are managed/build by maven. Extensions bundle/initialize/install plugins. [[The difference of PlugIn and Extension and Registry|Here's a quick explanation.]]

Maven also packages them into self contained distribution jar files that can be placed under 'lib/ext/' in your OJ installation to be used. In case the extension needs additional (not-jar) files the distribution is done as zip file containing jars and files/folder to be placed under 'lib/ext/'.

Strictly speaking a checkout of the complete OJ sources is not needed to develop an extension. It is perfectly possible to do so against an OJ portable distribution. We may document that later in case somebody requests it.

=== Import project ===

generally you repeat all steps from [[#Import into eclipse IDE|Import OJ into eclipse]] above.
but this time use
# URI ''https://github.com/openjump-gis/helloworld-extension.git''
# Folder name ''HelloWorld-Extension''
let the import finish and build.

=== Create run/debug configuration ===

same here. running OJ with the extension included utilizes the [[#Create run/debug configuration|basic run/debug configuration created above]]. we will duplicate it and add some command line parameters for the OJ plugin loader to find and load the extension classes/files during runtime.

simply put - we will remove the folders to look for additional extensions but provide a new one where the extensions classes are compiled to. additionally we use ''-limit-ext-lookup false'' to have OJ not only to look into jar files but additionally recurse through all folders and look for extension class files as well.

# Run > Run Configurations...
## expand '''Java Application''' on the left side; Right click '''OpenJUMP'''; Select '''Duplicate'''
## a new configuration '''OpenJUMP (1)''' will be created
## edit this configuration
## change '''Name''' above tabs from ''OpenJUMP (1)'' to ''HelloWorld''
## tab '''Arguments'''
### change '''Program arguments''' to ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -I18n en_US -v info -limit-ext-lookup false -extensions-directory ${workspace_loc:HelloWorld-Extension}/target/classes'' '''NOTE:''' we removed ''target/lib.ext.core,plus'' as the other extensions are not strictly needed to develop an extension, they slow down startup and clutter the interface. you may add those later to test incompatibilities against them later though.
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and the HelloWorld extension should show up under Plugins->Example.

Eclipse: Set up project and example extension from git sources

2024-07-12T13:13:32Z

Edso: /* Import project */

== Download and install eclipse (if not already available) ==
; Download and unzip from
: https://www.eclipse.org/downloads/packages/
: either
:: Package for Enterprise Java and Web Developers
:: Package for Java Developers
: each will do fine for OJ development

All the below was tested with eclipse version 2024.06.

== OpenJUMP project ==

=== Import into eclipse IDE ===
'''NOTE:''' The file system paths below are for windows but can analogous be some unix/linux/mac paths.
# Start the eclipse application
# Create and open a new workspace e.g. ''C:\workspace-OpenJUMP''
# File > Import...
## Git > Projects from Git (with smart import) ; Next>
## Clone URI ; Next>
## enter URI ''https://github.com/openjump-gis/openjump.git'' ; Next>
## make sure at least branch ''main'' is selected ; Next>
## choose a location for the project folder e.g. ''C:\workspace-OpenJUMP\OpenJUMP'' ; Next>
## eclipse will now clone the git repository into the project folder
# Import Projects dialog pops up
## Folder ''OpenJUMP'' should be preselected '''Import as Maven'''
## Finish>
eclipse should now build the maven project without errors (warnings can be ignored)

=== Create run/debug configuration ===
When the project builds fine you will need to provide some information to be able to run OJ directly from the built project.
# Run > Run Configurations...
## Right click '''Java Application''' on the left side ; Select '''New Configuration'''
## change '''Name''' above tabs from ''New Configuration'' to ''OpenJUMP''
## tab '''Main'''
### make sure '''Project''' is ''OpenJUMP''
### add '''Main Class''' ''com.vividsolutions.jump.workbench.JUMPWorkbench''
## tab '''Arguments'''
### add '''Program arguments''' ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -extensions-directory "target\lib.ext.core" -extensions-directory "target\lib.ext.plus" -I18n en_US -v info'' '''NOTE:''' you can change the language/region with the parameter '''-I18n''' or raise the log verbosity to debug with '''-v''' or remove ''-extensions-directory "target\lib.ext.plus"'' to simulate OJ CORE
### add '''VM arguments''' ''-Djava.system.class.loader=com.vividsolutions.jump.workbench.plugin.PlugInClassLoader''
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and be able to do so in the future. you can also debug OJ by selecting the created run configuration under '''Run > Debug Configurations...''' . 
there are also handy buttons on the toolbar available to do so quickly. note the small downward arrows beside them!

== HelloWorld extension ==

OJ extension projects usually are managed/build by maven. Extensions bundle/initialize/install plugins. [[The difference of PlugIn and Extension and Registry|Here's a quick explanation.]]

Maven also packages them into self contained distribution jar files that can be placed under 'lib/ext/' in your OJ installation to be used. In case the extension needs additional (not-jar) files the distribution is done as zip file containing jars and files/folder to be placed under 'lib/ext/'.

Strictly speaking a checkout of the complete OJ sources is not needed to develop an extension. It is perfectly possible to do so against an OJ portable distribution. We may document that later in case somebody requests it.

=== Import project ===

generally you repeat all steps from [[#Import into eclipse IDE|Import OJ into eclipse]] above.
but this time use
# URI ''https://github.com/openjump-gis/helloworld-extension.git''
# project name ''HelloWorld-Extension''
let the import finish and build.

=== Create run/debug configuration ===

same here. running OJ with the extension included utilizes the [[#Create run/debug configuration|basic run/debug configuration created above]]. we will duplicate it and add some command line parameters for the OJ plugin loader to find and load the extension classes/files during runtime.

simply put - we will remove the folders to look for additional extensions but provide a new one where the extensions classes are compiled to. additionally we use ''-limit-ext-lookup false'' to have OJ not only to look into jar files but additionally recurse through all folders and look for extension class files as well.

# Run > Run Configurations...
## expand '''Java Application''' on the left side; Right click '''OpenJUMP'''; Select '''Duplicate'''
## a new configuration '''OpenJUMP (1)''' will be created
## edit this configuration
## change '''Name''' above tabs from ''OpenJUMP (1)'' to ''HelloWorld''
## tab '''Arguments'''
### change '''Program arguments''' to ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -I18n en_US -v info -limit-ext-lookup false -extensions-directory ${workspace_loc:HelloWorld-Extension}/target/classes'' '''NOTE:''' we removed ''target/lib.ext.core,plus'' as the other extensions are not strictly needed to develop an extension, they slow down startup and clutter the interface. you may add those later to test incompatibilities against them later though.
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and the HelloWorld extension should show up under Plugins->Example.

Eclipse: Set up project and example extension from git sources

2024-07-12T13:12:44Z

Edso:

== Download and install eclipse (if not already available) ==
; Download and unzip from
: https://www.eclipse.org/downloads/packages/
: either
:: Package for Enterprise Java and Web Developers
:: Package for Java Developers
: each will do fine for OJ development

All the below was tested with eclipse version 2024.06.

== OpenJUMP project ==

=== Import into eclipse IDE ===
'''NOTE:''' The file system paths below are for windows but can analogous be some unix/linux/mac paths.
# Start the eclipse application
# Create and open a new workspace e.g. ''C:\workspace-OpenJUMP''
# File > Import...
## Git > Projects from Git (with smart import) ; Next>
## Clone URI ; Next>
## enter URI ''https://github.com/openjump-gis/openjump.git'' ; Next>
## make sure at least branch ''main'' is selected ; Next>
## choose a location for the project folder e.g. ''C:\workspace-OpenJUMP\OpenJUMP'' ; Next>
## eclipse will now clone the git repository into the project folder
# Import Projects dialog pops up
## Folder ''OpenJUMP'' should be preselected '''Import as Maven'''
## Finish>
eclipse should now build the maven project without errors (warnings can be ignored)

=== Create run/debug configuration ===
When the project builds fine you will need to provide some information to be able to run OJ directly from the built project.
# Run > Run Configurations...
## Right click '''Java Application''' on the left side ; Select '''New Configuration'''
## change '''Name''' above tabs from ''New Configuration'' to ''OpenJUMP''
## tab '''Main'''
### make sure '''Project''' is ''OpenJUMP''
### add '''Main Class''' ''com.vividsolutions.jump.workbench.JUMPWorkbench''
## tab '''Arguments'''
### add '''Program arguments''' ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -extensions-directory "target\lib.ext.core" -extensions-directory "target\lib.ext.plus" -I18n en_US -v info'' '''NOTE:''' you can change the language/region with the parameter '''-I18n''' or raise the log verbosity to debug with '''-v''' or remove ''-extensions-directory "target\lib.ext.plus"'' to simulate OJ CORE
### add '''VM arguments''' ''-Djava.system.class.loader=com.vividsolutions.jump.workbench.plugin.PlugInClassLoader''
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and be able to do so in the future. you can also debug OJ by selecting the created run configuration under '''Run > Debug Configurations...''' . 
there are also handy buttons on the toolbar available to do so quickly. note the small downward arrows beside them!

== HelloWorld extension ==

OJ extension projects usually are managed/build by maven. Extensions bundle/initialize/install plugins. [[The difference of PlugIn and Extension and Registry|Here's a quick explanation.]]

Maven also packages them into self contained distribution jar files that can be placed under 'lib/ext/' in your OJ installation to be used. In case the extension needs additional (not-jar) files the distribution is done as zip file containing jars and files/folder to be placed under 'lib/ext/'.

Strictly speaking a checkout of the complete OJ sources is not needed to develop an extension. It is perfectly possible to do so against an OJ portable distribution. We may document that later in case somebody requests it.

=== Import project ===

generally you repeat all steps from [[#Import into eclipse IDE|Import OJ into eclipse]] above.
but this time use
# URI ''https://github.com/openjump-gis/openjump.git''
# project name ''HelloWorld-Extension''
let the import finish and build.

=== Create run/debug configuration ===

same here. running OJ with the extension included utilizes the [[#Create run/debug configuration|basic run/debug configuration created above]]. we will duplicate it and add some command line parameters for the OJ plugin loader to find and load the extension classes/files during runtime.

simply put - we will remove the folders to look for additional extensions but provide a new one where the extensions classes are compiled to. additionally we use ''-limit-ext-lookup false'' to have OJ not only to look into jar files but additionally recurse through all folders and look for extension class files as well.

# Run > Run Configurations...
## expand '''Java Application''' on the left side; Right click '''OpenJUMP'''; Select '''Duplicate'''
## a new configuration '''OpenJUMP (1)''' will be created
## edit this configuration
## change '''Name''' above tabs from ''OpenJUMP (1)'' to ''HelloWorld''
## tab '''Arguments'''
### change '''Program arguments''' to ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -I18n en_US -v info -limit-ext-lookup false -extensions-directory ${workspace_loc:HelloWorld-Extension}/target/classes'' '''NOTE:''' we removed ''target/lib.ext.core,plus'' as the other extensions are not strictly needed to develop an extension, they slow down startup and clutter the interface. you may add those later to test incompatibilities against them later though.
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and the HelloWorld extension should show up under Plugins->Example.

Eclipse: Set up project and example extension from git sources

2024-07-12T13:09:41Z

Edso: /* HelloWorld extension */

== Download and install eclipse (if not already available) ==
; Download and unzip from
: https://www.eclipse.org/downloads/packages/
: either
:: Package for Enterprise Java and Web Developers
:: Package for Java Developers
: each will do fine for OJ development

All the below was tested with eclipse version 2024.06.

== OpenJUMP project ==

=== Import into eclipse IDE ===
'''NOTE:''' The file system paths below are for windows but can analogous be some unix/linux/mac paths.
# Start the eclipse application
# Create and open a new workspace e.g. ''C:\workspace-OpenJUMP''
# File > Import...
## Git > Projects from Git (with smart import) ; Next>
## Clone URI ; Next>
## enter URI ''https://github.com/openjump-gis/openjump.git'' ; Next>
## make sure at least branch ''main'' is selected ; Next>
## choose a location for the project folder e.g. ''C:\workspace-OpenJUMP\OpenJUMP'' ; Next>
## eclipse will now clone the git repository into the project folder
# Import Projects dialog pops up
## Folder ''OpenJUMP'' should be preselected '''Import as Maven'''
## Finish>
eclipse should now build the maven project without errors (warnings can be ignored)

=== Create run/debug configuration ===
When the project builds fine you will need to provide some information to be able to run OJ directly from the built project.
# Run > Run Configurations...
## Right click '''Java Application''' on the left side ; Select '''New Configuration'''
## change '''Name''' above tabs from ''New Configuration'' to ''OpenJUMP''
## tab '''Main'''
### make sure '''Project''' is ''OpenJUMP''
### add '''Main Class''' ''com.vividsolutions.jump.workbench.JUMPWorkbench''
## tab '''Arguments'''
### add '''Program arguments''' ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -extensions-directory "target\lib.ext.core" -extensions-directory "target\lib.ext.plus" -I18n en_US -v info'' '''NOTE:''' you can change the language/region with the parameter '''-I18n''' or raise the log verbosity to debug with '''-v''' or remove ''-extensions-directory "target\lib.ext.plus"'' to simulate OJ CORE
### add '''VM arguments''' ''-Djava.system.class.loader=com.vividsolutions.jump.workbench.plugin.PlugInClassLoader''
## save configuration with button '''Apply''' (bottom right)
## run configuration with button '''Run''' (bottom right)

eclipse should now start OJ and be able to do so in the future. you can also debug OJ by selecting the created run configuration under '''Run > Debug Configurations...''' . 
there are also handy buttons on the toolbar available to do so quickly. note the small downward arrows beside them!

== HelloWorld extension ==

OJ extension projects usually are managed/build by maven. Extensions bundle/initialize/install plugins. [[The difference of PlugIn and Extension and Registry|Here's a quick explanation.]]

Maven also packages them into self contained distribution jar files that can be placed under 'lib/ext/' in your OJ installation to be used. In case the extension needs additional (not-jar) files the distribution is done as zip file containing jars and files/folder to be placed under 'lib/ext/'.

Strictly speaking a checkout of the complete OJ sources is not needed to develop an extension. It is perfectly possible to do so against an OJ portable distribution. We may document that later in case somebody requests it.

=== Import project ===

generally you repeat all steps from [[#Import into eclipse IDE|Import OJ into eclipse]] above.
but this time use
# URI ''https://github.com/openjump-gis/openjump.git''
# project name ''HelloWorld-Extension''
let the import finish and build.

=== Create run/debug configuration ===

same here. running OJ with the extension included utilizes the [[#Create run/debug configuration|basic run/debug configuration created above]]. we will duplicate it and add some command line parameters for the OJ plugin loader to find and load the extension classes/files during runtime.

simply put - we will remove the folders to look for additional extensions but provide a new one where the extensions classes are compiled to. additionally we use ''-limit-ext-lookup false'' to have OJ not only to look into jar files but additionally recurse through all folders and look for extension class files as well.

# Run > Run Configurations...
## expand '''Java Application''' on the left side; Right click '''OpenJUMP'''; Select '''Duplicate'''
## a new configuration '''OpenJUMP (1)''' will be created
## edit this configuration
## change '''Name''' above tabs from ''OpenJUMP (1)'' to ''HelloWorld''
## tab '''Arguments'''
### change '''Program arguments''' to ''-default-plugins scripts\default-plugins.xml -extensions-directory "lib\ext" -I18n en_US -v info -limit-ext-lookup false -extensions-directory ${workspace_loc:HelloWorld-Extension}/target/classes'' '''NOTE:''' we removed ''target/lib.ext.core,plus'' as the other extensions are not strictly needed to develop an extension, they slow down startup and clutter the interface. you may add those later to test incompatibilities against them later though.

Eclipse: Set up project and example extension from git sources

2024-07-12T12:32:54Z

Edso: /* Import project */

Eclipse: Set up project and example extension from git sources

2024-07-12T12:29:20Z

Edso: /* Import project */

Eclipse: Set up project and example extension from git sources

2024-07-12T12:27:34Z

Edso: /* HelloWorld extension */

Main Page

2024-07-12T12:11:29Z

Edso: /* OpenJUMP GIS - The free, cross-platform and open source GIS for the World */

;NOTE
:This OpenJUMP wiki is from users for users and needs updates and improvements. Help for adding information but also to accomplish other things from documentation to programming is welcome (see [[Contact us]]).

== OpenJUMP GIS - The free, cross-platform and open source GIS for the World ==
[[image:114231354_7b5aa910b2.jpg|thumb|right|300px|OpenJUMP Screenshot]]

{| border="0" cellpadding="1" style="margin: 1em";
|align="left" |'''About OpenJUMP''' || style="width:50px" | || '''Get OpenJUMP'''
|-
| • [[What is OpenJUMP]]? (+) || || • [[Downloading OpenJUMP]]
|-
| • [[Who uses OpenJUMP]]? || || • [[Installation]]
|-
|- style="height:7px"
| || ||
|-
| align="left" |'''Use OpenJUMP''' || || '''Develop OpenJUMP'''
|-
| • [[Starting OpenJUMP]] for the first timers || || • [[How to translate OpenJUMP into another language|Translate OpenJUMP]]
|-
| • [[Using OpenJUMP]] (+) || || • [[Eclipse: Set up project and example extension from git sources]]
|-
| • [[Index|Online User Manual]] || || • [[Developing with OpenJUMP|Developer docs (mostly outdated)]]
|-
| • [[Plugins for OpenJUMP]] || || • [[OpenJUMP_Roadmap]]
|-
| • [[Online Tutorials]] || ||
|- style="height:7px"
| || ||
|-
|align="left" |'''Other''' || ||
|-
| • [[Contributors to OpenJUMP]]
|-
| • [[Contact us]] || ||
|-
| • [[Related Websites and Blogs]] || ||
|}

ToDo's: (o) cleanup, (+) write new/improve pages

== News ==
* [07 May 2023] - OpenJUMP 2.2.1 released ([[Downloading OpenJUMP#Releases|download]])
* [04 December 2022] - OpenJUMP 2.2.0 released ([[Downloading OpenJUMP#Releases|download]])
* [1 August 2022] - OpenJUMP 2.1 released ([[Downloading OpenJUMP#Releases|download]])
* [1 March 2022] - OpenJUMP 2.0 released ([[Downloading OpenJUMP#Releases|download]])

* [[Older News]]

== Editing this Wiki ==
* you can create a new account - and then request editing rights from user *Edso* on [[Special:EmailUser]]
* Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software. See also [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
* here is a list of [[Special:RecentChanges|recent changes]].

Eclipse: Set up project and extension from git sources

2022-08-01T14:17:29Z

Edso: /* News */

;NOTE
:This OpenJUMP wiki is from users for users and needs updates and improvements. Help for adding information but also to accomplish other things from documentation to programming is welcome (see [[Contact us]]).

== OpenJUMP GIS - The free, cross-platform and open source GIS for the World ==
[[image:114231354_7b5aa910b2.jpg|thumb|right|300px|OpenJUMP Screenshot]]

{| border="0" cellpadding="1" style="margin: 1em";
|align="left" |'''About OpenJUMP''' || style="width:50px" | || '''Get OpenJUMP'''
|-
| • [[What is OpenJUMP]]? (+) || || • [[Downloading OpenJUMP]]
|-
| • [[Who uses OpenJUMP]]? || || • [[Installation]]
|-
|- style="height:7px"
| || ||
|-
| align="left" |'''Use OpenJUMP''' || || '''Develop OpenJUMP'''
|-
| • [[Starting OpenJUMP]] for the first timers || || • [[How to translate OpenJUMP into another language|Translate OpenJUMP]]
|-
| • [[Using OpenJUMP]] (+) || || • [[Developing with OpenJUMP]] (o)
|-
| • [[Index|Online User Manual]] || || • [[Contributors to OpenJUMP]]
|-
| • [[Plugins for OpenJUMP]] || || • [[OpenJUMP_Roadmap]]
|-
| • [[Online Tutorials]] || ||
|- style="height:7px"
| || ||
|-
|align="left" |'''Other''' || ||
|-
| • [[Contact us]] || ||
|-
| • [[Related Websites and Blogs]] || ||
|}

ToDo's: (o) cleanup, (+) write new/improve pages

== News ==
* [1 August 2022] - OpenJUMP 2.1 released ([[Downloading OpenJUMP#Releases|download]])
* [1 March 2022] - OpenJUMP 2.0 released ([[Downloading OpenJUMP#Releases|download]])
* [3 January 2021] - OpenJUMP 1.16 released ([[Downloading OpenJUMP#Releases|download]])
* [16 February 2020] - New OpenJUMP 1.15 release ([[Downloading OpenJUMP|download]])
* [4 March 2019] - New OpenJUMP 1.14.1 maintenance release ([[Downloading OpenJUMP|download]])
* [1 January 2019] - New OpenJUMP 1.14 released ([[Downloading OpenJUMP|download]])
* [11 May 2018] - New OpenJUMP 1.13 is released ([[Downloading OpenJUMP|download]])
* [4 March 2018] - New OpenJUMP 1.12 is released ([[Downloading OpenJUMP|download]])

* [[Older News]]

== Editing this Wiki ==
* you can create a new account - and then request editing rights from user *Edso* on [[Special:EmailUser]]
* Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software. See also [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
* here is a list of [[Special:RecentChanges|recent changes]].

Creating an OJ release version

2022-08-01T14:16:50Z

Edso: /* The release step by step list */

== New Build/Release Procedure ==

The new build and release procedure uses maven.

; ATTENTION:
: Always run maven from the root of your checked out svn folder. Meaning chdir into it first and make sure it is your current working dir.

=== '''Maven profiles''' ===
Command line to build and package OpenJUMP with maven is
: <pre> mvn package -P <profile>,<profile>,...</pre>
where profile is at least one of the following:

:; snapshot
:: packages a ''snapshot'' of the basic edition ''core'' and ''plus'' (plus extensions from lib/plus)
:; release
:: builds of ''core'' and ''plus'' targeted for release, which can be named via
::: <pre>-D version.number=X.X.X -D version.release=release </pre>
:: they mainly differ from ''snapshots'' because they
::: - do not contain source code
::: - do not expose language files in ''language/'' folder

: example results:
:: target/OpenJUMP-20120423-r2834-CORE.zip
:: target/OpenJUMP-20120423-r2834-PLUS.zip

the following profiles can be added to build additional files

:; portable
:: builds portable zip files, one per edition. takes care of setting executable bits and recompresses jar files.
:: example results:
::: target/recompress/OpenJUMP-Portable-20120423-r2834-CORE.zip
::: target/recompress/OpenJUMP-Portable-20120423-r2834-PLUS.zip
:; installer (needs portable)
:: builds multi platform executable izpack installers (*.jar,*.exe) for both ''core'' and ''plus'' from the portable packaging
:: example result:
::: target/izpack/OpenJUMP-Installer-20120423-r2834-CORE.jar
::: target/izpack/OpenJUMP-Installer-20120423-r2834-CORE.exe
::: target/izpack/OpenJUMP-Installer-20120423-r2834-PLUS.jar
::: target/izpack/OpenJUMP-Installer-20120423-r2834-PLUS.exe
:; srczip
:: a zip file containing the source files of the build
:: example result:
::: target/OpenJUMP-20120425-r2834-src.zip
:; javadoc
:: build java doc html files for the current source
:: example result:
::: target/apidocs/

==== '''Build a release example''' ====
The command line to release a new version of OpenJUMP is
mvn package -P release[,portable[,installer]][,srczip][,javadoc] -D version.number=X.X.X -D version.release=release

* for releases you might want to give a version.number (default=unknown) and a version.release (default=release)
* version.release should have one of two values : release or snapshot

example
cd <svn-checkout-folder>/
mvn package -P release -D version.number=1.5.1

=== '''The release ''step by step'' list''' ===

# Check etc/readme.txt (new components, licenses, contributors ...?)
## update and commit.
# summarize the changes to the previous version in Changes.txt, based on the [https://github.com/openjump-gis/openjump/commits git commit log] (copy/sorting out), commit to trunk
# add svn tag
# build release files with maven as outlined above
# test startup on all supported platform (if possible)
# update release notes (sf.net files readme.txt)
# upload the files to sourceforge's FRS
## release files
## readme.txt (sf.net files version)
# assign default download button per platform under file info (i)
# update Download links
## on [[Main_Page|Wiki front page]]
## on [[Downloading OpenJUMP|Download wiki page]]
## on http://openjump.org website
# announce release
## on sf.net wiki frontpage news
## on the devel/user mailing lists

== Old release process ==
* update the readme.txt
* summarize the changes to the previous version, based on the change log file (copy/sorting out)
* compile everything with the Ant script (check the java version to compile against)
* add the license, openjump.exe, and readme files (if not already included)
* so the platform independent zip & source release may be ready after copying the lic files into the zip (but best is to compare the zip content of an older release with the just created version)
* create a win-installer using Nullsoft NSIS (maybe with a pointer to download java 1.6) and include before-hand the ecw and mrsid libs into this edition (see also the notes on the svn for the past releases: e.g. for [http://jump-pilot.svn.sourceforge.net/viewvc/jump-pilot/core/trunk/installer/1.3.1/ OJ 1.3.1])
* create another zip/release version that includes the sextante tools, postgis and print-plugin; based on the platform independent zip
* write the release notes
* upload the files to sourceforge
* make an announcement on slashgeo & our wiki & our sourceforge new section & change our webpage/links
* finally, updating of the documentation on the wiki on the new functions