]> git.argeo.org Git - gpl/argeo-slc.git/blobdiff - org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html
- Documentation
[gpl/argeo-slc.git] / org.argeo.slc / src / main / java / org / argeo / slc / ant / package.html
index 14a54d1af121a5ce2475a703e7f179607a205537..9f36fb1bf5373af5bcf0aa4f4c310b853029bf77 100644 (file)
@@ -2,13 +2,37 @@
 <head></head>\r
 <body>\r
 Bases classes for SLC Ant extensions.\r
-<h2>Usage of SLC Ant extensions</h2>\r
-Add:\r
-<pre>\r
-&lt;taskdef resource="org/argeo/slc/ant/taskdefs.properties" /&gt;\r
-</pre>\r
-at the beginning of your file.\r
+<h2>Introduction</h2>\r
+SLC Ant allows to integrate Ant and Spring in order to run an\r
+application based on top of SLC. Sequence of actions are defined in Ant\r
+files with specific Ant tasks referencing Spring beans implementing the\r
+SLC interfaces. The properties of these beans can be overridden at\r
+runtime in the Ant scripts.\r
+<br />\r
+SLC Ant also provides a tree-based implementation of the SLC structure\r
+which allows to uniquely identify and reference the various actions.\r
 \r
+<h2>Installation</h2>\r
+The structure will be first defined by the directory tree where the Ant\r
+files are stored. In order to define the root of this tree, you need to\r
+place in the root directory an\r
+<b>SLC Ant root file</b>\r
+(default name: slcRoot.properties).\r
+<br />\r
+In this root file you can define a configuration directory and a work\r
+directory (default values are provided if they are not explicitly set).\r
+<br />\r
+Additional properties can then be defined in files stored under the\r
+configuration directory.\r
+<br />\r
+For details about the configuration and the various properties, please\r
+refer to {@link org.argeo.slc.ant.SlcAntConfig}.\r
+\r
+<h2>Running SLC Ant</h2>\r
+SLC Ant can be run either via pure Ant scripts or programmatically using\r
+{@link org.argeo.slc.ant.AntRegistryUtil}. In both cases, make sure that\r
+SLC and its dependencies are in the classpath (Spring (always), logging\r
+system such as log4j, Hibernate, etc.).\r
 \r
 </body>\r
 </html>
\ No newline at end of file