How To... Start a Project - Project Descriptors | ![]() |
Properties Descriptor | ||
The file properties.xml describes various properties for your project. Use this file to define properties for use by the antlibs. For full details about you need. When imported by centipede each XML element and attribute becomes an alement in the property name. For example, the properties document below defines cent properties such as centipede.tools.checkstyle.properties=conf/checkstyle.properties, centipede.tools.antlibs.forrest.loglevel=WARN and centipede.tools.antlibs.forrest.skin.name="avalon-site" (note how the last one is an attribute). For detils of the properties available in each cent you need to consult the documentation for the antlibs (which at the time of writing are almost non-existent, so ask you questions on our support system or users mailing list
. In order to illustrate the use of this file we will look at the file provided by the krysalis-project template:
<?xml version="1.0"?> <!-- Build properties - these override any property specified in the build --> <properties> <centipede> <tools> <antlibs> <antidote /> <junit /> <checkstyle > <properties>conf/checkstyle.properties</properties> </checkstyle> <javasrc /> <forrest > <loglevel>WARN</loglevel> builtin available skins: basic jakarta-site avalon-site scarab-site xml-apache-site forrest-site (Work In Progress) You can also use your own skin by putting it in src/documentation/override/skins. It will be see by Forrest as any other skin. <skin name="avalon-site"> <navlinks> <link1 href="http://www.sf.net/">sourceforge</link1> <link2 href="http://www.krysalis.org/">krysalis</link2> <link3 href="http://www.krysalis.org/centipede/">centipede</link3> </navlinks> <logo> <group src="images/group-logo.gif" href="http://www.krysalis.org" /> <project src="images/project-logo.gif" href="http://www.krysalis.org/centipede/" /> </logo> </skin> </forrest> </antlibs> </tools> </centipede> </properties>
by Ross D. Gardler