readme

AIOTrade is a free, open source stock technical analysis platform built on pure java. Its pluggable

netbeans - build everything needed for the NBM. Do not override; use
netbeans-extra instead.

netbeans-extra - hook target: does nothing unless overridden, but called when
building a module. Override to insert any additional build tasks you need to do:
copying libraries to the cluster, etc.

profile - used from inside the IDE (if the NetBeans profiler is installed) to
profile the entire application.

profile-test-single-nb - run one unit test under the profiler. Available from the
IDE's menus if the NetBeans profiler is installed.

release - copies contents of ${release.dir} to ${cluster}.

reload - reloads the module in the target IDE/app to try out changes interactively.

reload-in-ide - reloads the module in the current IDE to try out changes
interactively. Only available when run from inside NetBeans. Use with care.

run - build module and then run application interactively. Only for external
modules. Either way, available from context menu in Projects tab.

test - run all unit tests for the module. Run -> Test... in the IDE.

test-build - build unit tests for the module.

test-init - define properties used for building and running unit tests.

test-preinit - I'm not sure, actually.

test-single - run a selected unit test only. Available in the IDE's menus.

testuserdir-delete - deletes just the testing user directory (if not currently in use).

verify-class-linkage [since 5.0u1] - checks for possible linkage errors in your module
and its Class-Path extensions.

SUITE PROPERTIES
----------------

Some properties are shared with module projects, such as ${cluster}.

app.name - filename of application launchers to create, suite name to create,
etc.

branding.dir (default "${suite.dir}/branding") - directory containing branding
overrides.

branding.token - optional token defining an application branding.

enabled.clusters - comma-separated list of cluster names in the target platform
(e.g. "platform6") which should be included in the application. Should be stored
in platform.properties, not project.properties. Since 5.0u1.

disabled.clusters - comma-separated list of cluster names in the target platform
(e.g. "ide6") which should be completely excluded from the application.
DEPRECATED since 5.0u1 in favor of ${enabled.clusters} and ignored if that is nonempty.

disabled.modules - comma-separated list of code name bases of modules in the
target platform (e.g. "org.netbeans.modules.autoupdate") which should be
excluded from the application. There is no need to specify modules already
excluded by ${disabled.clusters} (if used) or by modules from clusters not included
in ${enabled.clusters}. Since 5.0u1, should be stored in platform.properties,
not project.properties.

modules - list of contained modules. Path format; entries resolved against the
suite directory as needed.

jnlp.codebase [since 5.0u1] - in case one wants to build a static repository not
packaged in a WAR file, one needs to pass in the full URL for it. By default it
is specified as "$$codebase" and replaced dynamically by the servlet packaged in
the WAR file.


TARGETS AVAILABLE FOR OVERRIDING IN YOUR SUITE build.xml
--------------------------------------------------

-init - set up properties. Most importantly, ${modules.sorted} contains a list
of absolute path names to the base directories of the modules in the suite,
topologically sorted by build order; suitable for use with <subant>, for
example. Some other basic properties like ${netbeans.dest.dir} will also be
defined.

branding - building branding JARs, if applicable. Example: if ${branding.token}
is "foo", then a file such as

    ${branding.dir}/modules/org-netbeans-modules-x.jar/org/netbeans/modules/x/resources/Bundle.properties

will be packed into

    ${cluster}/modules/locale/org-netbeans-modules-x_foo.jar!/org/netbeans/modules/x/resources/Bundle_foo.properties

build - build all suite modules.

build-jnlp - builds a JNLP WAR file from your application suitable for
publishing in a Java EE container.

build-mac [since 5.0u2] - creates a Mac OS X application.

build-zip - builds a ZIP file containing your application including launchers.

clean - clean everything.

debug - like run, but run in the JPDA debugger. (Only available from inside the
IDE.)

debug-jnlp - starts debuging of your JNLP application (works only from NetBeans IDE)

nbms [since 5.0u1] - creates NBMs for all modules in the suite, and generates
an XML descriptor listing them suitable for use from Auto Update.

profile - used from inside the NetBeans IDE to profile the entire suite

run - start application for testing.

run-jnlp - executes your JNLP application (currently from local files)

testuserdir-delete - deletes just the testing user directory (if not currently in use).

CONTENTS OF YOUR manifest.mf
----------------------------

This file is just a prototype of the module JAR manifest, as described in the
Modules API. It must contain the attribute OpenIDE-Module and is strongly
encouraged to contain also OpenIDE-Module-Localizing-Bundle; other attributes
are generally optional.

Several attributes in the main section should *not* be written into this file as
they are automatically generated during the build:

    Class-Path
    OpenIDE-Module-Build-Version
    OpenIDE-Module-Friends
    OpenIDE-Module-IDE-Dependencies
    OpenIDE-Module-Implementation-Version (unless you are exporting an impl API)
    OpenIDE-Module-Module-Dependencies
    OpenIDE-Module-Public-Packages
    OpenIDE-Module-Specification-Version (unless you are *not* using spec.version.base)

Do not forget that manifest files must begin with the magic phrase

    Manifest-Version: 1.0

and to be safe should end in *two* newlines.

UPGRADING FROM NETBEANS 5.x
---------------------------

Upgrading from NetBeans 5.x (including 5.0, 5.0 with Update 1 of the module
development support, and 5.5) is trivial. If you do not need to specify test
dependencies, you do not need to do anything. If you do:

1. Make sure you are using a 5.0u2+ harness.

2. Execute the 'fix-test-dependencies' Ant target for your module project. It
will switch your project.xml to the /3 schema. Test dependencies defined in
${test.unit.cp.extra} and/or ${test.unit.run.cp.extra} in project.properties are
moved to <test-dependencies> in project.xml. Only dependencies which do not
correspond to modules will be left as is.

UPGRADING FROM NETBEANS 4.0/4.1
-------------------------------

Upgrading an NBM project from an older 4.x version of NetBeans is not trivial
but should not pose too much difficulty once you get the hang of it. (A tool may
be provided in the future to do it for you.)

1. Switch to the /2 or /3 XML schema for project.xml *and validate the result*
to make sure it is syntactically correct. Delete any <javadoc/> element.

2. Delete the <path> element from project.xml. Add <suite-component/> or
<standalone/> for an external module.

3. For externally located modules in a suite, create a module suite project and
refer to it from suite.properties; for standalone external modules, just create
platform.properties with "nbplatform.active=default". Delete build.xml and open
the project to create a default version (which you can edit as needed to
override some targets); opening the project should also make you a
build-impl.xml and set 'user.properties.file' in suite-private.properties or
platform-private.properties.

4. Some targets that used to be defined in projectized.xml are now imported
indirectly from common.xml, so overrides like

    <target name="compile" depends="projectized.compile">...</target>

must be changed to

    <target name="compile" depends="projectized-common.compile">...</target>

Targets currently moved to common.xml:

    -pre-debug-fix
    arch
    arch-nb
    basic-init
    clean
    compile
    compile-single
    compile-test-single
    debug-fix-nb
    debug-fix-test-nb
    debug-test-single
    debug-test-single-nb
    do-debug-test-single
    files-init
    jar (*)
    jar-prep
    module-auto-deps
    module-xml-autoload
    module-xml-eager
    module-xml-regular
    nbm
    netbeans
    netbeans-extra
    reload
    test
    test-build
    test-init
    test-preinit
    test-single

(*) 'jar-no-module-deps' and 'jar-with-module-deps' were replaced with just
'jar'. If you are overriding this target, be sure to use the new
<jarwithmoduleattributes> task which predefines a number of useful manifest
attributes for you.

5. Clean out unnecessary stuff from manifest.mf: remove all substituted values
(@SOMETHING@), and pay attention to these attributes in particular:

5a. OpenIDE-Module-Specification-Version - still OK, but if you import and/or
export implementation dependencies, you may prefer to define spec.version.base
in project.properties (see above).

5b. OpenIDE-Module-Implementation-Version - still OK, *if* you are exporting an
implementation dependency, but now strongly encouraged to be a literal integer.

5c. OpenIDE-Module-Build-Version - delete; it will be inserted by the build
harness automatically.

5d. Class-Path - delete and use <class-path-extension>s in project.xml instead.

5e. OpenIDE-Module-IDE-Dependencies, OpenIDE-Module-Module-Dependencies,
OpenIDE-Module-Public-Packages - you should not have been using these to begin
with, but if you were, delete them now: the harness generates them for you as
appropriate.

6. Avoid use of cp.extra in project.properties if possible. In most cases it is
no longer necessary: any <class-path-extension>s you define, or which are
defined by a module you declare a compile-time dependency on, will automatically
be inserted into your classpath for you.

Currently there is no clean way to declare inter-module unit test dependencies,
but this may be added in the future. For now, use ${test.unit.cp.extra} and/or
${test.unit.run.cp.extra} (see above).

7. Do not override files-init; it is rarely necessary any more. Instead specify
extra.module.files in project.properties. Or for files you are just copying
unmodified, just put them in the correct folder structure beneath a subdirectory
called "release".

8. Delete any complicated build.xml tricks to handle implementation
dependencies. Just declare the dependency normally in project.xml using
<implementation-version/> (and use ${spec.version.base}, above) and you are
done.

9. Remove any special definitions relating to Rich Unger's "cluster harness",
which is obsoleted by this new system.

10. Consider using <friend-packages> instead of <public-packages> if you want to
export a limited API without using implementation dependencies. *Will not work
in NB 4.1, only 5.0+.*

11. Do not pick an explicit name for your module; accept
modules/${code.name.base.dashes}.jar. It can be autoload or eager just by
setting properties in project.properties, without using modules/autoload or
modules/eager.

12. All properties of the form ${nb.*.dir} were removed and replaced by the
literal directory name. For example, ${nb.modules.dir} is now just "modules". Be
careful - some names were tricky, e.g. ${nb.lib.dir} was "core", and
${nb.bin.dir} and ${nb.lib/ext.dir} were both "lib"!

13. ${netbeans.dest.dir}/${cluster.dir} should be replaced by just ${cluster}.

14. Have fun!


----------------
Hey Emacs!
Local Variables:
fill-column: 80
End: