Developers

Table of Contents Requirements Eclipse Git Maven JUnit tests Directory structure (assembly) Publish deliverables Inkscape extensions

Requirements

A development environment requires a Git client and a Maven client, standalone and/or integrated in an IDE. Some subprojects require Java-6+, the inkscape sub project requires an installed Inkscape instance.

Eclipse

Eclipse is just one of the IDE's you can use. The following scenarios are intended for Eclipse users new to Git and/or Maven.

Git

The online git book is a good reference, note the section on the GitHub workflow and its problems

Within eclipse the staging view and the history view in the git perspective are your friend to manage your commits and branches. Occasionally you may need an alternative to untangle eclipse.

As a shortcut to get your local clone, just paste the URL of your public fork into the staging view. The history view has "all branches" by default switched off, you might want to switch it on.

Maven

Following the advise above, the dibl project should not yet be in the project explorer. If it got there as a side effect of another cloning scenario, you might have to remove from the project explorer and import it properly:

• File menu - maven - existing maven project - browse to the local dibl folder
• Check the projects you are interested in, online you can find the projects by typing pom.xml at the finder
• Build the projects with the master build (its starts with the sub projects that create zip/tar.gz files to install) or build each project one by one. Anyway: right click an imported project - run as - maven build... - fill in the goals "clean install". Or use the command "`mvn clean install`".

JUnit tests

Many test are not much more than smoke tests if just executed. Visually examine the diagrams produced in the target folders. If they are different from the template, look like a diagram and don't have internal loose ends, they are usually OK.

Directory structure (assembly)

The directory structure of the sub-projects look like but don't yet exactly match the suggested standard structure.

Note that some of the projects have a folder src/main/assembly. These folder have a dist.xml file that packages compilation results and the rest of the assembly folder in a zip respective a tar.gz. This xml file may put the version number of the pom file in some of the files. So far, the created packages are neither installers nor executables. So a wiki page and/or readme file in te package should explain installation and execution.

Publish deliverables

See stackoverflow, note that currently each sub-project has its own release numbering.

Finally edit the tagged release to uploaded the created zip / tar.gz and short release notes.

Inkscape extensions

See http://wiki.inkscape.org/wiki/index.php/Script_extensions

You might not want to copy the .inx and .py files between the Inkscape extension folder (the execution environment) and the local git repository of DiBL (the IDE environment). In a unix/OS-X environment you can create links from inkscpae files to git files with the command

ln -s <git-file> <inkscape-file>

A change in a .inx file requires a restart of Inkscape, to test a change in a .py file, you can even keep the dialog open.

Suggestion for files related to a specific extension: repeat the extension name in the assembly/dist tree.