XProject plugin for oXygen
Florent Georges
I have just release a new plugin for the oXygen XML IDE, in order to
support XProject, the XML Project Manager tool. More infos on the
XProject page at http://expath.org/modules/xproject/.
XProject (loosly) defines a directory structure for an XML project:
my-project/
src/
...
xproject/
project.xml
The subdir src/ has whatever structure you want for your XML files,
XSLT stylesheets, XQuery modules, XProc pipelines, resource files, and
everything that is part of your project. The subdir xproject/
contains meta informations about your project. E.g. project.xml
contains its name and version number, as well as several processors
configuration for unit-testing purposes.
Based on conventions for the components filename (i.e. *.xsl for
stylesheets, *.xql for XQuery library modules, *.xq, *.xqy or *.xquery
for XQuery main modules, etc.) it detects them in src/, and based on
annotations in those files, it generates automatically a package
descriptor and create the package for you.
You can also generate a "delivery file" that contains the package, a
README file, examples and source code. Or automatically launch unit-
tests using XSpec. Or generate documentation for your XQuery modules
using xquerydoc. Every dependency is already included in the plugin.
To install, download the file xproject-oxygen-plugin-0.3.0.zip from:
http://code.google.com/p/expath-pkg/downloads/list
and unzip it in your oXygen install dir, in the subdir plugins/ (or
copy the dir xproject/ which is at the root of the ZIP file into
<your-oxygen>/plugins/).
The next time you start oXygen, you will have 4 more buttons in the
toolbar, named "Build", "Test", "Doc" and "Release". While editing
any file within your project directory, you can click one of those
buttons to execute the corresponding XProject target.
"Build" creates a new package in dist/ based on src/, "Test" run the
XSpec tests in test/ and place the reports in the same dir (see the
sample project in the ZIP to see how to configure your processors and
XML databases to run the tests), "Doc" places the XQuery documentation
in dist/xqdoc/, and "Release" creates a new delivery file in dist/.
The packages created by "Build" can be installed automatically in
any EXPath Packaging System-compliant system.
Any feedback, help, request for improvement is welcome! In
particular, I would like to know how I can help a user creating a new
project from within oXygen (e.g. by displaying a form to fill in the
basic info like its name, version, etc. and create the project
structure, and possibly by creating an Author mode for the project.xml
files).
Enjoy!
--
Florent Georges
http://fgeorges.org/
http://h2oconsulting.be/