Project: AntAcid Version: 1.0.2 Author: T Master (aka Ultra Funkular, funkular@nettaxi.com) Date: April - June 2002 Copyright: T Master License: TBA ------------------------------------------------------------------------------- ****************************************************************************** PUPROSE: ======= AntAcid is a Rapid Development tool for writing Ant build scripts. An understanding of what Ant is and does, and the purpose of each Task is required. However, AntAcid saves a developer from memorising the supported attributes and nested tasks. INTERFACE: ========= The application has a main Window Frame with a menu, statusbar, tree control and a property sheet / tabbed pane. Interaction is through extensive PopupMenu actions on the Tree control. GETTING STARTED: =============== Pre-requisites: -------------- You will need the following jars in your classpath: - JDK1.3.1 - ant.jar v1.4 (from jakarta.apache.org/ant/) - jaxp.jar - sax.jar Running AntAttack: ----------------- java -jar AntAcid.jar OR java -jar AntAcid.jar -workspace /home/me/myworkspace.ant (this will load the saved workspace into AntAcid) OR java -cp jakarta-ant-1.4.jar:AntAcid.jar funkular.gui.wizard.AntWizard -workspace myworkspace.act Defining a new Workspace: ------------------------ A workspace can hold several Ant Build files. 1. Select the "Workspaces:" tree node. 2. Display the popupmenu. 3. Select "New Workspace" and select a directory and new filename. (The file suffix ".ant" is added automatically). Alternatively, use "Load Workspace" to select a previously defined workspace. 4. A new workspace node will appear. Defining a new Build File: ------------------------- 1. Select a workspace tree node. 2. Display the popupmenu. 3. Select "New Build File" and select a directory and new filename. (The file suffix ".xml" is added automatically). Alternatively, use "Load Build File" to select a previously defined build file. 4. A new build file node will appear. Deleting a Build File: ---------------------- 1. Select the build file node. 2. Display the popupmenu. 3. Select "Delete". Note: This will also delete the file that exists permanately. Generating the XML Build File: ----------------------------- 1. Select the build file node. 2. Display the popupmenu. 3. Select "Generate XML". There may be a short wait. Alternaitvely, a different filename can be generated by selected "Generate XML As...". Previewing the XML without creating the file: --------------------------------------------- 1. Select the build file node. 2. Display the popupmenu. 3. Select "Preview XML". There may be a short wait. 4. Select the "Preview" Tabbed Panel on the right hand side of the application window. Adding an XML Comment: --------------------- 1. Select any task node BELOW the node. 2. Display the popupmenu. 3. Select "XML Comment". 4. A comment node (orange) will be added below the selected task node. To edit it's contents, select the comment node, then type the details in the Task Attribute panel and press "Save Changes" when done. N.B: comments may only be placed anywhere under a node. Not before. RFE: (Request For Enhancement) ==== 1. Syntax colour highlighting of the preview panel. 2. Printing support. 3. Move nested tasks, to change order of xml generation. (need to implement draggable nodes) Bugs: Report bugs to: funkular@nettaxi.com Subject = "AntAcid - bug" i======================================================================== 1. Copying task nodes not a DEEP copy. only shallow. (Minor) 2. Directory paths from DirectoryChooser with an extra '/'. (Minor) 3. Select a file from the FileChooser dialog for a "file" attribute, does not include the directory path. 4. Deleting rows in table throws ArrayIndexOutOfBoundsException. (FIXED in v0.9.7) 5. Can Paste in table without an copied item in buffer. (FIXED in v0.9.8) 6. Parsing of ant.dtd not working. No debug printlns echoed. file: AntTaskProperties.java (FIXED in v.0.9.9.4) (Implemented own DTDParser and AntTaskDefinitions to replace AntTaskProperties) - June 15/16. (Uses Ant api to create the ant.dtd too, thereby becoming futureproof!!) -. Now performs parsing at startup in another thread. (FIXED v0.9.9.5) June 17. 7. Fixed DTD Parser for attributes. (FIXED v0.9.9.6) June 17 8. Optimised dynamic popupmenu creation. Fixed old optimsation bug which resulted in no menu items. (FIXED in v.0.9.9.7) June 17. 9. Popup menu of attributes on tabe, to re-add in those deleted. (FIXED in v0.9.9.8) June 17. 10. If ant.dtd missing, cannot generate new one. (FIXED in v0.9.9.9) - June 17/18. 11. The "Target" task node has a very long popupmenu. No scrolling or similar to view all contents. <<<< TO DO >>>> LIMITATIONS: =========== 1. Import Ant Script - does not support importing comments. (FIXED in v1.0.2) - June 24 Fix: - funkular.io.AntHandler must use a LexicalHandler subclass. - support a comment tasktype node. ------------------------------------------------------------------------ Last updated: Tue Jun 25 22:41:40 MDT 2002.